> ## Documentation Index
> Fetch the complete documentation index at: https://developers.parkes.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Parkes CLI

> Manage skills, knowledge, connections, and automated work from your terminal.

`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](https://developers.parkes.ai/cli/INSTALLATION.md), install and check the version:

```bash theme={null}
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](https://developers.parkes.ai/cli/INSTALLATION.md#upgrade).

## Sign in

For a fresh installation, create a production profile and authorize it:

```bash theme={null}
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](https://developers.parkes.ai/cli/AUTHENTICATION.md) for multiple organizations and unattended use.

## Start with a read

```bash theme={null}
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:

```bash theme={null}
parkes --help
parkes skills --help
parkes skills create --help
```

Continue with [API requests](https://developers.parkes.ai/cli/API_REQUESTS.md) for raw HTTP calls, or [scripting](https://developers.parkes.ai/cli/SCRIPTING.md) for pagination, output formats, confirmations, and exit codes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.