---
title: "Console quickstart"
description: "Create a saved Project, generate a CLI for your API, run it locally, and connect GitHub."
url: https://typeship.dev/docs/quickstart/console
markdown: https://typeship.dev/docs/quickstart/console.md
section: "Get started"
---
> ## Documentation index
> Fetch the complete documentation index at https://typeship.dev/llms.txt (every page, one line each) or the full text at https://typeship.dev/llms-full.txt.
> Append .md to any docs URL, or send Accept: text/markdown, for the markdown twin of that page.

# Console quickstart

Create a saved Project, generate a CLI for your API, run it locally, and connect GitHub.

> For AI agents: use https://typeship.dev/agents.md for the command-driven equivalent of this Console path.

This walkthrough creates a CLI from your API through the Typeship Console. At the end, your API operations are runnable commands and Typeship is ready to keep the package current.

_Available on every plan. Free retains and analyzes the complete API contract; generated packages include the first 25 operations._

1. **Create a Project**
   
   Sign in to the [Console](https://typeship.dev/console), choose **New project**, and name the API product. Add the URL or GitHub location of its OpenAPI or GraphQL entrypoint.
   
   Typeship resolves referenced documents and analyzes the complete contract before it saves the Project.

2. **Choose CLI**
   
   Select **CLI** as the product to generate. Typeship names the command after the API, so an API titled `Acme` produces the `acme` command.
   
   You can add an MCP server or TypeScript, Python, and Go SDKs later. Each one remains an independent package and release stream.

3. **Generate the package**
   
   Open **Generations** and choose **Generate now**. Open the CLI result to browse its files, warnings, source revision, and operation coverage.
   
   Download the generated package and extract it into a working directory.

4. **Build and run the CLI**
   
   ```bash
   cd acme-cli
   npm install
   npm run build
   node dist/cli.js --help
   ```
   
   The help output lists commands derived from your API's resources and operations. Run one with the credentials your API expects:
   
   ```bash
   export ACME_TOKEN="your-api-token"
   node dist/cli.js accounts list --limit 5
   ```

5. **Keep it current with GitHub**
   
   Install the Typeship GitHub App on the Definition and destination repositories. Add a repository Delivery to the CLI, generate once more, then enable **Automatic generation**.
   
   Definition pull requests will receive API review and generation results. Changed CLI packages will receive their own release pull requests.

> **For AI agents:** Create the same saved workflow with `typeship projects create --name "Acme API" --definition '{"source":{"kind":"url","url":"https://api.acme.example.com/openapi.json"}}' --targets '[{"name":"Acme CLI","generator":"cli"}]'` after authentication.

## Next

Read [CLI](https://typeship.dev/docs/targets/cli) for the generated command contract, or [Connect GitHub](https://typeship.dev/docs/integrations/github) for source and destination review.

## Sitemap

[Every page of these docs](https://typeship.dev/llms.txt)