Blame
|
1 | # CLI |
||||||
| 2 | ||||||||
|
3 | The AeThex CLI is the command-line interface for developers, operators, and maintainers who need repeatable local workflows. |
||||||
|
4 | |||||||
|
5 | <div class="docs-section-heading"> |
||||||
| 6 | <h2>Role in the ecosystem</h2> |
|||||||
| 7 | <p>The CLI should make common AeThex workflows scriptable without replacing the API or dashboard.</p> |
|||||||
| 8 | </div> |
|||||||
| 9 | ||||||||
| 10 | Use the CLI for tasks that benefit from automation: project setup, authentication checks, local configuration, deployment helpers, API inspection, and operational diagnostics. |
|||||||
| 11 | ||||||||
| 12 | ## Expected workflows |
|||||||
| 13 | ||||||||
| 14 | - Authenticate with AeThex using [[Authentication]]. |
|||||||
| 15 | - Select an organization, team, or project context. |
|||||||
| 16 | - Inspect API resources from [[Api-Reference]]. |
|||||||
| 17 | - Generate local config for [[SDKs]]. |
|||||||
| 18 | - Run checks for permissions, tokens, or integration health. |
|||||||
|
19 | |||||||
|
20 | ## Command design principles |
||||||
| 21 | ||||||||
| 22 | - Commands should be explicit and safe by default. |
|||||||
| 23 | - Destructive commands should ask for confirmation unless run in CI-safe mode. |
|||||||
| 24 | - Output should support both human-readable and JSON modes. |
|||||||
| 25 | - Errors should include next-step guidance and links back to docs. |
|||||||
| 26 | ||||||||
| 27 | <div class="docs-grid"> |
|||||||
| 28 | <a class="docs-card" href="/Authentication">Authentication</a> |
|||||||
| 29 | <a class="docs-card" href="/SDKs">SDKs</a> |
|||||||
| 30 | <a class="docs-card" href="/Api-Reference">API Reference</a> |
|||||||
| 31 | <a class="docs-card" href="/Projects">Projects</a> |
|||||||
| 32 | </div> |
|||||||
| 33 | ||||||||
| 34 | > [!NOTE] |
|||||||
| 35 | > Document actual commands here as the CLI stabilizes. Avoid inventing command syntax before implementation exists. |
|||||||