Skip to content

Commit dddc7b9

Browse files
docs: updated README
1 parent 25a843d commit dddc7b9

1 file changed

Lines changed: 83 additions & 12 deletions

File tree

README.md

Lines changed: 83 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ The official command-line interface for [CreateOS](https://createos.nodeops.netw
1414

1515
## Installation
1616

17-
### Download binary
18-
19-
Download the latest release for your platform from the [Releases](../../releases) page and place it somewhere on your `$PATH`.
20-
21-
### Build from source
22-
2317
Requires Go 1.21+.
2418

2519
```bash
@@ -52,12 +46,89 @@ createos --help
5246

5347
## Commands
5448

55-
| Command | Description |
56-
| ----------------- | --------------------------- |
57-
| `createos login` | Sign in with your API token |
58-
| `createos logout` | Sign out |
59-
| `createos whoami` | Show your account info |
60-
| `many more :)` | |
49+
### Authentication
50+
51+
| Command | Description |
52+
| -------------------- | ---------------------------------- |
53+
| `createos login` | Sign in with your API token |
54+
| `createos logout` | Sign out |
55+
| `createos whoami` | Show the currently authenticated user |
56+
57+
### Projects
58+
59+
| Command | Description |
60+
| ------------------------- | ------------------------ |
61+
| `createos projects list` | List all projects |
62+
| `createos projects get` | Get a project by ID |
63+
| `createos projects delete`| Delete a project |
64+
65+
### Deployments
66+
67+
| Command | Description |
68+
| ----------------------------------- | ------------------------------------ |
69+
| `createos deployments list` | List deployments for a project |
70+
| `createos deployments logs` | Stream runtime logs for a deployment |
71+
| `createos deployments build-logs` | Stream build logs for a deployment |
72+
| `createos deployments retrigger` | Retrigger a deployment |
73+
| `createos deployments wakeup` | Wake up a sleeping deployment |
74+
| `createos deployments delete` | Delete a deployment |
75+
76+
### Environments
77+
78+
| Command | Description |
79+
| -------------------------------- | --------------------------------- |
80+
| `createos environments list` | List environment variables |
81+
| `createos environments delete` | Delete an environment variable |
82+
83+
### Domains
84+
85+
| Command | Description |
86+
| ---------------------------- | ---------------------------------- |
87+
| `createos domains list` | List custom domains for a project |
88+
| `createos domains add` | Add a custom domain |
89+
| `createos domains refresh` | Refresh domain DNS verification |
90+
| `createos domains delete` | Remove a custom domain |
91+
92+
### VMs
93+
94+
| Command | Description |
95+
| ------------------------ | ------------------------------------ |
96+
| `createos vms list` | List VM instances |
97+
| `createos vms get` | Get details of a VM |
98+
| `createos vms deploy` | Deploy a new VM |
99+
| `createos vms ssh` | Connect to a VM via SSH |
100+
| `createos vms reboot` | Reboot a VM |
101+
| `createos vms resize` | Resize a VM to a different plan |
102+
| `createos vms terminate` | Terminate a VM |
103+
104+
### Skills
105+
106+
| Command | Description |
107+
| -------------------------- | ---------------------------- |
108+
| `createos skills catalog` | Browse the skills catalog |
109+
| `createos skills purchased`| List your purchased skills |
110+
111+
### OAuth
112+
113+
| Command | Description |
114+
| -------------------------------- | ---------------------------------- |
115+
| `createos oauth clients list` | List OAuth clients |
116+
| `createos oauth clients create` | Create a new OAuth client |
117+
118+
### Users
119+
120+
| Command | Description |
121+
| --------------------------------------- | ---------------------------------- |
122+
| `createos users oauth-consents list` | List OAuth consents |
123+
| `createos users oauth-consents revoke` | Revoke an OAuth consent |
124+
125+
### Other
126+
127+
| Command | Description |
128+
| ----------------------------- | -------------------------------------------- |
129+
| `createos ask` | Ask the AI assistant to help manage your infrastructure |
130+
| `createos completion` | Generate shell completion script (bash/zsh/fish/powershell) |
131+
| `createos version` | Print the current version |
61132

62133
## Options
63134

0 commit comments

Comments
 (0)