Metadata-Version: 2.4
Name: developer-platform-cli
Version: 0.3.0
Summary: Command-line client for the Developer Platform API
Requires-Python: >=3.12
Requires-Dist: httpx<1,>=0.28
Requires-Dist: keyring<26,>=25
Requires-Dist: platformdirs<5,>=4
Requires-Dist: pydantic<3,>=2.10
Requires-Dist: rich<14,>=13.9
Requires-Dist: typer<1,>=0.15
Provides-Extra: dev
Requires-Dist: pytest<9,>=8.3; extra == 'dev'
Requires-Dist: respx<1,>=0.22; extra == 'dev'
Description-Content-Type: text/markdown

# Developer Platform CLI

This source-adjacent README provides the minimal development example. The
canonical user documentation is the [CLI guide](../../docs/developers/cli.md);
implementation ownership is in the [maintainer guide](../../docs/maintainers/cli.md).

`devplat` is the command-line client for the Developer Platform API. It supports
CI deployments and project administration, including hosted application access.
Use `devplat --help` and `devplat access --help` to inspect commands.

Install an editable development copy:

```bash
python3 -m pip install -e 'platform/cli[dev]'
```

Set the values returned when the deployment credential was created. Keep the secret
in the CI system's protected environment and disable shell tracing around this step:

```bash
export PLATFORM_API_URL=https://platform.example
export PLATFORM_TOKEN_ENDPOINT=https://identity.example/realms/platform/protocol/openid-connect/token
export PLATFORM_CLIENT_ID='...'
export PLATFORM_CLIENT_SECRET='...'
devplat deploy apply --project hello --file examples/project.json --wait
```

`PLATFORM_ACCESS_TOKEN` may be used instead of the deployment-credential variables
for a short-lived, externally obtained token. The CLI never persists either form of
authentication material. Deployment credentials authorize deployment and observation
only; access administration requires a human project-administrator login or an
externally supplied administrator token. See the [CLI guide](../../docs/developers/cli.md)
for profiles, login, access commands, and versioned updates.
