Blame
|
1 | # CLI |
||||||
| 2 | ||||||||
|
3 | The AeThex CLI documentation currently defines the intended operational contract. Treat commands not present in the installed CLI as planned rather than shipped. |
||||||
|
4 | |||||||
|
5 | | Field | Value | |
||||||
| 6 | |---|---| |
|||||||
| 7 | | Product maturity | In development | |
|||||||
| 8 | | Documentation status | Active | |
|||||||
| 9 | | Last verified | 2026-06-26 | |
|||||||
|
10 | |||||||
| 11 | ## Expected workflows |
|||||||
| 12 | ||||||||
|
13 | A stable AeThex CLI should eventually support: |
||||||
| 14 | ||||||||
| 15 | - Identity and session inspection. |
|||||||
| 16 | - Project initialization. |
|||||||
| 17 | - Configuration validation. |
|||||||
| 18 | - Build and deployment workflows. |
|||||||
| 19 | - API and service health checks. |
|||||||
| 20 | - Documentation and OpenAPI retrieval. |
|||||||
| 21 | ||||||||
| 22 | ## Verify before use |
|||||||
| 23 | ||||||||
| 24 | Before following a command example: |
|||||||
| 25 | ||||||||
| 26 | ```bash |
|||||||
| 27 | aethex --version |
|||||||
| 28 | aethex --help |
|||||||
| 29 | ``` |
|||||||
| 30 | ||||||||
| 31 | If the command is unavailable, use the documented HTTP or web workflow instead. Do not install an unverified package solely because it uses the AeThex name. |
|||||||
| 32 | ||||||||
| 33 | ## Command design requirements |
|||||||
| 34 | ||||||||
| 35 | - Non-interactive mode for automation. |
|||||||
| 36 | - Structured output such as JSON. |
|||||||
| 37 | - Explicit confirmation for destructive actions. |
|||||||
| 38 | - No credentials in process arguments when a safer input method exists. |
|||||||
| 39 | - Useful exit codes. |
|||||||
| 40 | - Dry-run behavior for deployment and mutation commands. |
|||||||
|
41 | |||||||
|
42 | ## Current alternatives |
||||||
|
43 | |||||||
|
44 | - Use [[API Quickstart]] for direct API access. |
||||||
| 45 | - Use [[OpenAPI Reference]] to generate a client. |
|||||||
| 46 | - Use the appropriate public service from [[Service Directory]]. |
|||||||
|
47 | |||||||
|
48 | ## Related documentation |
||||||
|
49 | |||||||
|
50 | - [[SDKs]] |
||||||
| 51 | - [[API Reference]] |
|||||||
| 52 | - [[Security]] |
|||||||
| 53 | - [[Projects]] |
|||||||