Parkes CLI

parkes is the command-line client for the Parkes REST API. Use it to sign in to an organization, inspect resources, run skills, and script work without building your own HTTP client.

Install

The CLI is currently available for macOS on Apple Silicon and Intel, through a private Homebrew tap. You need access to ParkesAI/homebrew-internal and a GitHub CLI login authorized to read it. With the prerequisites in place, install and check the version:

brew tap ParkesAI/internal
HOMEBREW_GITHUB_API_TOKEN="$(gh auth token)" brew install ParkesAI/internal/parkes
parkes --version

Use 0.1.2 or later for the current organization-scoped API. If you already installed the CLI, follow the upgrade instructions. For a fresh installation, create a production profile and authorize it:

parkes config profiles create production --host https://api.parkes.ai
parkes --profile production auth login
parkes --profile production auth status --output json

The browser prompts you to sign in and select one organization. Credentials are stored in your OS credential store. If the profile already exists, reuse it. See authentication and profiles for multiple organizations and unattended use.

Start with a read

parkes --profile production skills list --limit 10 --output json

Named commands handle authentication and request formatting. Your token’s scopes and current organization permissions still apply.

What you can do

Task	Example
Browse skills	`parkes skills list`
Inspect a skill	`parkes skills get SKILL_UUID`
Explore knowledge	`parkes knowledge namespaces list`
Inspect connections	`parkes connections list`
Observe a run	`parkes runs logs RUN_UUID --follow`
Follow activity	`parkes activity tail --output jsonl`
Make a raw request	`parkes api GET /rest/v1/me`

Replace uppercase placeholders with real IDs returned by the API. These examples use your active profile; add --profile production to select it explicitly.

Find a command

Use the resource pages in Command reference for exact arguments and flags, or inspect help in your terminal:

parkes --help
parkes skills --help
parkes skills create --help

Continue with API requests for raw HTTP calls, or scripting for pagination, output formats, confirmations, and exit codes.

Get started

Use the CLI

Command reference

Install

Start with a read

What you can do

Find a command

​Install

​Sign in

​Start with a read

​What you can do

​Find a command

Install

Sign in

Start with a read

What you can do

Find a command