> ## 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.

# Installation

> Prepare a supported Python environment and install the ThinkPlatform CLI and SDK.

The `ThinkPlatform-client` package contains the `tp` CLI and public Python SDK. It connects to an existing ThinkPlatform service; get your deployment's connection settings before signing in.

Install the CLI and SDK from PyPI. The current release is **0.6.134**.

## Supported environments

The client is distributed as binary wheels for these environments:

| Python | Operating system | Architecture |
| - | - | - |
| CPython 3.11, 3.12, or 3.13 | Linux with glibc 2.28+ | x86\_64 |
| CPython 3.11, 3.12, or 3.13 | macOS 11+ | Apple silicon (arm64) |
| CPython 3.11, 3.12, or 3.13 | Windows | x86\_64 |

Intel macOS is excluded from the initial release. Public source distributions are also outside this release, so an unsupported environment cannot fall back to building the client from source.

## Create a fresh environment

Use a separate virtual environment for the client. The examples select Python 3.13; substitute 3.11 or 3.12 if that is your supported interpreter.

**Bash (Linux or macOS)**

```bash theme={"system"}
python3.13 -m venv .venv
source .venv/bin/activate
python --version
python -m pip install --upgrade pip
```

**PowerShell (Windows)**

```powershell theme={"system"}
py -3.13 -m venv .venv
.\.venv\Scripts\Activate.ps1
python --version
python -m pip install --upgrade pip
```

If PowerShell prevents activation, use `.\.venv\Scripts\python.exe` in place of `python` and `.\.venv\Scripts\tp.exe` in place of `tp` in the following commands.

## Install the client

Install from PyPI in the activated environment:

```bash theme={"system"}
python -m pip install ThinkPlatform-client
```

## Verify the installation

These commands run locally and do not require credentials:

```bash theme={"system"}
tp --version
tp --help
tp profile setup --help
```

Set up your connection and project interactively:

```bash theme={"system"}
tp profile setup
tp canvas pages list
```

The wizard guides sign-in and numbered organization/project selection, then saves the profile after confirmation. See [Authentication](https://docs.thinkplatform.ai/cli/get-started/authentication.md) for deployment settings and [Projects and profiles](https://docs.thinkplatform.ai/cli/guides/context.md) for manual setup and scripts.

## Upgrade

Upgrade within your client environment:

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

If you previously used the full `ThinkPlatform` runtime package, create a fresh environment for `ThinkPlatform-client`. Keep your runtime environment separate rather than installing both distributions over the same package files.

## Troubleshooting

> [accordion] pip cannot find a matching distribution
>
> Check `python --version`, your operating system, and interpreter architecture against the supported matrix. Upgrade pip in that environment and retry. Linux requires glibc 2.28+; Intel macOS and unsupported Python versions have no initial public wheel.

> [accordion] The package installed, but tp is not found
>
> Activate the environment where you installed the client and rerun `python -m pip show ThinkPlatform-client`. The `tp` executable lives in that environment's `bin` directory on Linux/macOS or `Scripts` directory on Windows. You can also invoke `.venv/bin/tp` or `.\.venv\Scripts\tp.exe` directly from the directory containing `.venv`.

> [accordion] pip uses a different Python environment
>
> Run installation through `python -m pip` after activating the environment. Check `python --version` and `python -m pip --version` to confirm the interpreter and pip location before retrying.

> [accordion] An upgrade behaves unexpectedly after using the full package
>
> Create a new virtual environment and install only the client there. Verify `tp --version` and `tp --help` before configuring authentication. Avoid copying installed package files between environments.

For changes from older versions, including the Apps command split, see [Upgrade and migration](https://docs.thinkplatform.ai/cli/guides/upgrading.md).


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