Quickstart

Generate the CLI from your working directory:

typeship packages generate \
  --spec '{"url":"https://typeship.dev/examples/petstore/openapi.yaml"}' \
  --target '{"type":"cli"}' \
  --out ./generated/cli

--target takes a JSON descriptor. To generate another sample Target, change type to mcp, typescript_sdk, python_sdk, or go_sdk, and give it its own --out directory. Each tab under Use the result shows the full command for its Target.

The Typeship CLI operates Typeship. One-shot generation saves no Project. Check the printed summary for warnings and omitted operations. For protected sources, see Generate from a URL. To maintain multiple Targets together, create a Project.

Generate from your working directory:

typeship packages generate \
  --spec '{"url":"https://typeship.dev/examples/petstore/openapi.yaml"}' \
  --target '{"type":"cli"}' \
  --out ./generated/cli

Then run cd generated/cli. If you downloaded this Target from the Console, open its extracted package directory instead.

Build your CLI

With the toolchain version listed in the generated README installed, run from the generated CLI directory:

go build -o petstore .
./petstore pets list --help

Make your first request

The sample exposes one read operation, pets list:

./petstore pets list --json

The command prints the pets as JSON. It exits nonzero if the request fails.

Generate from your working directory:

typeship packages generate \
  --spec '{"url":"https://typeship.dev/examples/petstore/openapi.yaml"}' \
  --target '{"type":"mcp"}' \
  --out ./generated/mcp

Then run cd generated/mcp. If you downloaded this Target from the Console, open its extracted package directory instead.

This path connects a downloaded local MCP package. It needs Node.js 20 or later, npm, and Claude Code. You do not need a generated CLI Target or a hosted Delivery.

Build the MCP package, then add its local executable to Claude Code from that directory:

npm install
npm run build
claude mcp add --scope local petstore -- node "$(pwd)/dist/mcp.js"
claude mcp list
claude

The server selects the supported protocol automatically. On Windows PowerShell, replace $(pwd)/dist/mcp.js with the absolute path to the built file. In Claude Code, allow the local server connection when prompted, then ask:

List the petstore server's tools, then call pets_list with no arguments.
Show the returned JSON.

Discovery should include pets_list. Its successful result contains the sample pet shown below. Claude Code connects with its default protocol settings; if the client reports an unsupported protocol version, update it and check the client compatibility guidance. For a missing executable, check the absolute path. Follow MCP connection troubleshooting.

A hosted MCP endpoint is a separate connection using a URL. See Connect MCP clients after adding a hosted Delivery to a saved Project.

Generate from your working directory:

typeship packages generate \
  --spec '{"url":"https://typeship.dev/examples/petstore/openapi.yaml"}' \
  --target '{"type":"typescript_sdk"}' \
  --out ./generated/typescript

Then run cd generated/typescript. If you downloaded this Target from the Console, open its extracted package directory instead.

Build the package with Node.js 20 or later and npm:

npm install
npm run build

Save example.mjs beside package.json:

import { PetstoreClient } from "./dist/index.js";

const pets = await new PetstoreClient({}).pets.list();
console.log(JSON.stringify(pets));

node example.mjs

Generate from your working directory:

typeship packages generate \
  --spec '{"url":"https://typeship.dev/examples/petstore/openapi.yaml"}' \
  --target '{"type":"python_sdk"}' \
  --out ./generated/python

Then run cd generated/python. If you downloaded this Target from the Console, open its extracted package directory instead.

Use Python 3.11 or later. From the directory containing pyproject.toml, create an environment and install the local package:

python3 -m venv .venv
.venv/bin/python -m pip install .

On Windows, use .venv\Scripts\python.exe in place of .venv/bin/python.

Save example.py beside pyproject.toml:

import json
from petstore import PetstoreClient

with PetstoreClient() as client:
    print(json.dumps(client.pets.list()))

.venv/bin/python example.py

A failed request raises an exception. Read the error before retrying.

Generate from your working directory:

typeship packages generate \
  --spec '{"url":"https://typeship.dev/examples/petstore/openapi.yaml"}' \
  --target '{"type":"go_sdk"}' \
  --out ./generated/go

Then run cd generated/go. If you downloaded this Target from the Console, open its extracted package directory instead.

Use Go 1.21 or later. In the directory containing go.mod, create cmd/example/main.go:

package main

import (
    "context"
    "encoding/json"
    "os"
    "example.com/petstore-go"
)

func main() {
    client, err := petstore.New()
    if err != nil { panic(err) }
    pets, err := client.Pets.List(context.Background())
    if err != nil { panic(err) }
    if err := json.NewEncoder(os.Stdout).Encode(pets); err != nil { panic(err) }
}

go run ./cmd/example

example.com/petstore-go is the module declared in this local sample's go.mod. The command builds it locally; no published module is required.