Skip to content

Commit 1e7b30f

Browse files
feat: addressed suggested changes
1 parent 1412d63 commit 1e7b30f

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,33 @@ createos --help
112112
| `createos projects get` | Get project details |
113113
| `createos projects delete` | Delete a project |
114114

115+
### Deploy
116+
117+
| Command | Description |
118+
| ----------------------- | -------------------------------------------------------- |
119+
| `createos deploy` | Deploy your project (auto-detects type) |
120+
121+
**Deploy flags:**
122+
123+
| Flag | Description |
124+
| ------------ | ------------------------------------------------------------------ |
125+
| `--project` | Project ID (auto-detected from `.createos.json`) |
126+
| `--branch` | Branch to deploy from (VCS/GitHub projects only) |
127+
| `--image` | Docker image to deploy (image projects only, e.g. `nginx:latest`) |
128+
| `--dir` | Directory to zip and upload (upload projects only, default: `.`) |
129+
130+
**Deploy behaviour by project type:**
131+
132+
| Project type | What happens |
133+
| -------------- | ------------------------------------------------------------------------------------- |
134+
| VCS / GitHub | Triggers from the latest commit. Prompts for branch interactively if not provided. |
135+
| Upload | Zips the local directory (respects `.gitignore`), uploads, and streams build logs. |
136+
| Image | Deploys the specified Docker image. |
137+
138+
**Files excluded from upload zip:**
139+
140+
Sensitive and noisy files are always excluded: `.env`, `.env.*`, secrets/keys (`*.pem`, `*.key`, `*.p12`, etc.), `node_modules`, build artifacts (`target`, `coverage`, etc.), OS/editor files, and anything listed in your project's `.gitignore`.
141+
115142
### Deployments
116143

117144
| Command | Description |
@@ -235,6 +262,12 @@ createos --help
235262
All commands accept flags so they work in CI and non-interactive environments. Destructive commands require `--force` to skip the confirmation prompt.
236263

237264
```bash
265+
# Deploy
266+
createos deploy # upload project — zips current dir
267+
createos deploy --dir ./dist # upload project — zip a specific dir
268+
createos deploy --branch main # VCS project — deploy from main
269+
createos deploy --image nginx:latest # image project
270+
238271
# Projects
239272
createos projects get --project <id>
240273
createos projects delete --project <id> --force

0 commit comments

Comments
 (0)