Skip to content

Commit fdc6798

Browse files
BhautikChudasamaBhautikChudasama
committed
docs: updated README
1 parent a802eef commit fdc6798

1 file changed

Lines changed: 125 additions & 55 deletions

File tree

‎README.md‎

Lines changed: 125 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,13 @@ Or run `createos login` interactively and select "Sign in with API token" when p
5454
createos whoami
5555
```
5656

57-
**3. Explore commands**
57+
**3. Link your project**
58+
59+
```bash
60+
createos init
61+
```
62+
63+
**4. Explore commands**
5864

5965
```bash
6066
createos --help
@@ -64,92 +70,156 @@ createos --help
6470

6571
### Authentication
6672

67-
| Command | Description |
68-
| -------------------- | ---------------------------------- |
69-
| `createos login` | Sign in with your API token |
70-
| `createos logout` | Sign out |
71-
| `createos whoami` | Show the currently authenticated user |
73+
| Command | Description |
74+
| ----------------- | ------------------------------------- |
75+
| `createos login` | Sign in with browser or API token |
76+
| `createos logout` | Sign out |
77+
| `createos whoami` | Show the currently authenticated user |
7278

7379
### Projects
7480

75-
| Command | Description |
76-
| ------------------------- | ------------------------ |
77-
| `createos projects list` | List all projects |
78-
| `createos projects get` | Get a project by ID |
79-
| `createos projects delete`| Delete a project |
81+
| Command | Description |
82+
| -------------------------- | ---------------- |
83+
| `createos projects list` | List all projects |
84+
| `createos projects get` | Get project details |
85+
| `createos projects delete` | Delete a project |
8086

8187
### Deployments
8288

83-
| Command | Description |
84-
| ----------------------------------- | ------------------------------------ |
85-
| `createos deployments list` | List deployments for a project |
86-
| `createos deployments logs` | Stream runtime logs for a deployment |
87-
| `createos deployments build-logs` | Stream build logs for a deployment |
88-
| `createos deployments retrigger` | Retrigger a deployment |
89-
| `createos deployments wakeup` | Wake up a sleeping deployment |
90-
| `createos deployments delete` | Delete a deployment |
89+
| Command | Description |
90+
| --------------------------------- | ------------------------------------ |
91+
| `createos deployments list` | List deployments for a project |
92+
| `createos deployments logs` | Stream runtime logs for a deployment |
93+
| `createos deployments build-logs` | Stream build logs for a deployment |
94+
| `createos deployments retrigger` | Retrigger a deployment |
95+
| `createos deployments wakeup` | Wake up a sleeping deployment |
96+
| `createos deployments cancel` | Cancel a deployment |
9197

9298
### Environments
9399

94-
| Command | Description |
95-
| -------------------------------- | --------------------------------- |
96-
| `createos environments list` | List environments for a project |
97-
| `createos environments delete` | Delete an environment |
100+
| Command | Description |
101+
| ------------------------------ | ------------------------------- |
102+
| `createos environments list` | List environments for a project |
103+
| `createos environments delete` | Delete an environment |
104+
105+
### Environment Variables
106+
107+
| Command | Description |
108+
| ---------------------- | ------------------------------------------------- |
109+
| `createos env list` | List environment variables for a project |
110+
| `createos env set` | Set one or more environment variables |
111+
| `createos env rm` | Remove an environment variable |
112+
| `createos env pull` | Download environment variables to a local `.env` file |
113+
| `createos env push` | Upload environment variables from a local `.env` file |
98114

99115
### Domains
100116

101-
| Command | Description |
102-
| ---------------------------- | ---------------------------------- |
103-
| `createos domains list` | List custom domains for a project |
104-
| `createos domains add` | Add a custom domain |
105-
| `createos domains refresh` | Refresh domain DNS verification |
106-
| `createos domains delete` | Remove a custom domain |
117+
| Command | Description |
118+
| -------------------------- | --------------------------------- |
119+
| `createos domains list` | List custom domains for a project |
120+
| `createos domains add` | Add a custom domain |
121+
| `createos domains verify` | Check DNS propagation and wait for verification |
122+
| `createos domains delete` | Remove a custom domain |
123+
124+
### Templates
125+
126+
| Command | Description |
127+
| -------------------------- | --------------------------------------------- |
128+
| `createos templates list` | Browse available project templates |
129+
| `createos templates info` | Show details about a template |
130+
| `createos templates use` | Download and scaffold a project from a template |
107131

108132
### VMs
109133

110-
| Command | Description |
111-
| ------------------------ | ------------------------------------ |
112-
| `createos vms list` | List VM instances |
113-
| `createos vms get` | Get details of a VM |
114-
| `createos vms deploy` | Deploy a new VM |
115-
| `createos vms ssh` | Connect to a VM via SSH |
116-
| `createos vms reboot` | Reboot a VM |
117-
| `createos vms resize` | Resize a VM to a different plan |
118-
| `createos vms terminate` | Terminate a VM |
134+
| Command | Description |
135+
| ------------------------ | ------------------------------- |
136+
| `createos vms list` | List VM instances |
137+
| `createos vms get` | Get details of a VM |
138+
| `createos vms deploy` | Deploy a new VM |
139+
| `createos vms ssh` | Connect to a VM via SSH |
140+
| `createos vms reboot` | Reboot a VM |
141+
| `createos vms resize` | Resize a VM to a different plan |
142+
| `createos vms terminate` | Permanently destroy a VM |
119143

120144
### Skills
121145

122-
| Command | Description |
123-
| -------------------------- | ---------------------------- |
124-
| `createos skills catalog` | Browse the skills catalog |
125-
| `createos skills purchased`| List your purchased skills |
146+
| Command | Description |
147+
| --------------------------- | -------------------------- |
148+
| `createos skills catalog` | Browse the skills catalog |
149+
| `createos skills purchased` | List your purchased skills |
150+
151+
### Quick Actions
152+
153+
| Command | Description |
154+
| ----------------- | ------------------------------------------------- |
155+
| `createos init` | Link the current directory to a CreateOS project |
156+
| `createos status` | Show a project's health and deployment status |
157+
| `createos open` | Open a project's live URL in your browser |
158+
| `createos scale` | Adjust replicas and resources for an environment |
126159

127160
### OAuth
128161

129-
| Command | Description |
130-
| -------------------------------- | ---------------------------------- |
131-
| `createos oauth clients list` | List OAuth clients |
132-
| `createos oauth clients create` | Create a new OAuth client |
162+
| Command | Description |
163+
| ------------------------------- | ------------------------ |
164+
| `createos oauth clients list` | List OAuth clients |
165+
| `createos oauth clients create` | Create a new OAuth client |
133166

134167
### Users
135168

136-
| Command | Description |
137-
| --------------------------------------- | ---------------------------------- |
138-
| `createos users oauth-consents list` | List OAuth consents |
139-
| `createos users oauth-consents revoke` | Revoke an OAuth consent |
169+
| Command | Description |
170+
| -------------------------------------- | ----------------------- |
171+
| `createos users oauth-consents list` | List OAuth consents |
172+
| `createos users oauth-consents revoke` | Revoke an OAuth consent |
140173

141174
### Other
142175

143-
| Command | Description |
144-
| ----------------------------- | -------------------------------------------- |
145-
| `createos ask` | Ask the AI assistant to help manage your infrastructure |
146-
| `createos completion` | Generate shell completion script (bash/zsh/fish/powershell) |
147-
| `createos version` | Print the current version |
176+
| Command | Description |
177+
| --------------------- | ------------------------------------------------------- |
178+
| `createos ask` | Ask the AI assistant to help manage your infrastructure |
179+
| `createos completion` | Generate shell completion script (bash/zsh/fish/powershell) |
180+
| `createos version` | Print the current version |
181+
182+
## Non-interactive / CI usage
183+
184+
All commands that would normally show an interactive prompt accept flags instead:
185+
186+
```bash
187+
# Projects
188+
createos projects get --project <id>
189+
190+
# Deployments
191+
createos deployments logs --project <id> --deployment <id>
192+
createos deployments retrigger --project <id> --deployment <id>
193+
194+
# Environments
195+
createos environments delete --project <id> --environment <id>
196+
197+
# Environment variables
198+
createos env list --project <id> --environment <id>
199+
createos env set KEY=value --project <id> --environment <id>
200+
createos env pull --project <id> --environment <id> --force
201+
202+
# Domains
203+
createos domains add example.com --project <id>
204+
createos domains verify --project <id> --domain <id> --no-wait
205+
createos domains delete --project <id> --domain <id>
206+
207+
# Templates
208+
createos templates use --template <id> --yes
209+
210+
# VMs
211+
createos vms get --vm <id>
212+
createos vms reboot --vm <id> --force
213+
createos vms terminate --vm <id> --force
214+
createos vms resize --vm <id> --size 1
215+
createos vms deploy --zone nyc3 --size 1
216+
```
148217

149218
## Options
150219

151220
| Flag | Description |
152221
| ------------- | ----------------------------------------------------- |
222+
| `--output json` | Output results as JSON (supported on most list/get commands) |
153223
| `--debug, -d` | Print HTTP request/response details (token is masked) |
154224
| `--api-url` | Override the API base URL |
155225

0 commit comments

Comments
 (0)