Console quickstart

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

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.

FreeAvailable on every planFree retains and analyzes the complete API contract; generated packages include the first 25 operations.

Create a Project

Sign in to the 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.

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.

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.

Build and run the CLI

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:

export ACME_TOKEN="your-api-token"
node dist/cli.js accounts list --limit 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.

Read CLI for the generated command contract, or Connect GitHub for source and destination review.