> For the complete documentation index, see [llms.txt](https://docs.scaleconnect.com.au/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scaleconnect.com.au/api/cli.md).

# CLI

{% @scale-docs-page-title/page-title title="CLI" %}

{% hint style="warning" %}
**Confirm before publishing:** whether a supported CLI will ship, executable and package names, installation and update channel, login or key handling, command grammar, output schemas, exit codes and support policy. No broker or internal product CLI has been verified; the commands on the child pages are a proposed interface.
{% endhint %}

The command-line interface exposes repeatable workflows over the same versioned API contracts used by other clients. It does not create a second set of permissions or business rules.

| CLI                                      | Reader                                 | Contract                                               |
| ---------------------------------------- | -------------------------------------- | ------------------------------------------------------ |
| [Broker CLI](/api/cli/broker-cli.md)     | Broker or approved brokerage developer | ScaleConnect public API and current broker permissions |
| [Internal CLI](/api/cli/internal-cli.md) | Scale operators                        | Separately authorized internal operations              |

## Common behaviour

A command should return a stable exit code, human-readable output by default and machine-readable JSON on request. Errors should identify the failed operation and request ID without printing secrets or client financial data into routine logs. Read commands may be rerun; write commands need explicit target IDs and a confirmation or `--yes` flag in noninteractive jobs.

Credentials belong in the operating system's secure store or an approved environment secret, not shell history or a command argument. `--help` should show required scopes and examples. A broker command must never see more data than the same user can reach through ScaleConnect.

The child pages define the intended command families. The final release needs an install guide, exact commands, option reference, tested examples and a version compatibility matrix.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.scaleconnect.com.au/api/cli.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.