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

> ## Agent Instructions
> Choose User guide for browser tasks, Developers for CLI, SDK and external agents, and Administration for organization management.
> Confirm identity and organization/project context before operations. Documentation access does not grant ThinkPlatform permissions.
> Review side effects, verify changes with a read, and do not blindly retry an operation with an uncertain outcome.
> Use documented UI steps for the web app and documented public CLI or SDK interfaces for automation. Follow each page’s prerequisites and authentication requirements.

# ThinkPlatform CLI

> Install the CLI, connect to your project, and read your first Canvas page.

`tp` is the ThinkPlatform CLI. Discover commands, inspect project resources, and automate platform operations with structured results.

## Install the client

Install the CLI and Python SDK from the public `ThinkPlatform-client` package:

```bash Installation theme={"system"}
python -m pip install ThinkPlatform-client
tp --version
tp --help
```

> [accordion] Supported platforms and package contents
>
> See [Installation](https://docs.thinkplatform.ai/cli/get-started/installation.md) for environment setup, supported platforms, upgrades, and troubleshooting.
>
> Use a fresh Python environment. The initial binary wheel release targets CPython **3.11–3.13** on Linux x86\_64 (glibc 2.28+), macOS 11+ on Apple silicon, and Windows x86\_64. Intel Macs and public source distributions are outside this initial release.
>
> The client connects to an existing ThinkPlatform service. It includes CLI and SDK access to platform APIs, including Flow and Agent operations. The client does not include their execution engines.

## Make your first read

**1. Discover the available commands**

Inspect help before choosing an operation. Help runs locally and does not require authentication.

```bash theme={"system"}
tp --help
tp commands
tp canvas pages list --help
```

Command groups and flags are covered in the [CLI reference](https://docs.thinkplatform.ai/cli/reference/commands.md).

**2. Set up your profile and choose a project**

Run the interactive setup in your terminal:

```bash theme={"system"}
tp profile setup
```

Enter a profile name, review the connection defaults, and complete sign-in. The wizard lists accessible organizations and projects by name. Choose each by number, then confirm the summary to save and activate the profile. You do not need to look up IDs.

With no connection settings configured, setup uses the production service and browser sign-in. For another deployment, use its administrator-approved settings. See [Authentication](https://docs.thinkplatform.ai/cli/get-started/authentication.md).

```bash theme={"system"}
tp context show
```

Check the saved destination. Setup requires an interactive terminal without JSON or query output; a person should complete it before handing work to an agent. Scripts can use the [manual context commands](https://docs.thinkplatform.ai/cli/guides/context.md#manual-selection-for-scripts).

**3. Read a page and verify the result**

List Canvas pages, choose an ID from the result, and read that page.

```bash theme={"system"}
tp canvas pages list
tp canvas pages get PAGE_ID
```

Check that the returned page matches the selected project and intended title. Page content is in the top-level `blocks` array. If the list is empty, use another project you can access; there is no need to create a page for this check.

See [Canvas pages](https://docs.thinkplatform.ai/cli/reference/commands.md#canvas-pages) for more read options.

## Give your agent a bounded task

Prepare the local [Agent skills](https://docs.thinkplatform.ai/cli/guides/agent-setup.md) when your coding agent supports skill files. You can also follow the commands directly; skill installation does not change your platform access.

Start with a request that makes the scope and expected result explicit:

```text theme={"system"}
Inspect the available ThinkPlatform CLI help. Confirm my identity and
organization/project context, then list up to five Canvas pages.
Read one page as JSON and summarize its title and content.
Do not create, update, or delete resources. Ask me to complete interactive
sign-in if required, and report the page ID you used to verify the result.
```

For automation, put global output flags before the command: `tp --json …` requests machine-readable JSON, while `--query` selects a field from the result. Keep IDs from discovery output rather than guessing them. See [output](https://docs.thinkplatform.ai/cli/reference/commands.md#output).

When you move on to changes, ask the agent to explain the target resources and intended effect first, then verify the resulting state with a read command.

## Next steps

* [Installation](https://docs.thinkplatform.ai/cli/get-started/installation.md): prepare your environment and verify the client.
* [Authentication](https://docs.thinkplatform.ai/cli/get-started/authentication.md): connect an account and manage profiles.
* [Agent skills](https://docs.thinkplatform.ai/cli/guides/agent-setup.md): inspect and install the bundled task guidance locally.
* [Choose an organization and project](https://docs.thinkplatform.ai/cli/guides/context.md): discover and verify the destination.
* [Read and update Canvas pages](https://docs.thinkplatform.ai/cli/guides/canvas-pages.md): complete a small resource workflow.
* [Files and Data Lake](https://docs.thinkplatform.ai/cli/guides/files.md): upload and inspect workflow inputs.
* [Run and monitor work](https://docs.thinkplatform.ai/cli/guides/execution.md): distinguish Flow runs, Agent tasks, and MLOps jobs.
* [Troubleshooting](https://docs.thinkplatform.ai/cli/guides/troubleshooting.md): diagnose context, permission, and uncertain execution outcomes.
* [Python SDK](https://docs.thinkplatform.ai/python-sdk/overview.md): use the public client from Python.

For container-backed applications, see [Publish a web app](https://docs.thinkplatform.ai/cli/guides/apps.md). Updating from an older client? Read [Upgrade and migration](https://docs.thinkplatform.ai/cli/guides/upgrading.md) before using old Apps scripts.


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