sitemills-cli 1.0.11 → 1.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -18
- package/dist/sitemills.js +1 -1
- package/dist/updater.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -108,9 +108,9 @@ SiteMills apps are built on declarative contracts, automatic RPC discovery, sand
|
|
|
108
108
|
|
|
109
109
|
```bash
|
|
110
110
|
sitemills-cli login # 1. sign in through your browser
|
|
111
|
-
sitemills-cli list # 2. find your app's ID
|
|
112
|
-
sitemills-cli export <
|
|
113
|
-
cd <
|
|
111
|
+
sitemills-cli list # 2. find your app's ID or site address
|
|
112
|
+
sitemills-cli export <app> # 3. download it (by ID or site address) into ./<app>
|
|
113
|
+
cd <app>
|
|
114
114
|
# 4. edit the files, then:
|
|
115
115
|
sitemills-cli check # compile your changes without saving anything
|
|
116
116
|
sitemills-cli push # upload your changes and update the branch preview
|
|
@@ -122,6 +122,7 @@ sitemills-cli deploy prod # 5. go live (or dev / staging)
|
|
|
122
122
|
- The `.sitemills/` folder is never uploaded, and it holds no secrets (your login token lives in `~/.sitemills`), so it's fine to commit it to your own git repo.
|
|
123
123
|
- Need a specific branch or folder name? `sitemills-cli export <projectId> <branchId> <outputDir>`.
|
|
124
124
|
- Every folder command also accepts the IDs explicitly: `sitemills-cli push <projectId> <branchId> <dir>`.
|
|
125
|
+
- Wherever a command takes `<projectId>`, you can give the app's **site address** instead: the `<site-address>` in `https://<site-address>.sitemills.com`. `sitemills-cli list` shows both. Older apps have the same project ID and site address; newer apps have a separate project ID.
|
|
125
126
|
|
|
126
127
|
### Starting from your own code
|
|
127
128
|
|
|
@@ -146,17 +147,17 @@ SiteMills clearly distinguishes between the **Platform Management Dashboard** an
|
|
|
146
147
|
|
|
147
148
|
| Purpose | URL / Hostname Pattern | Example |
|
|
148
149
|
|---|---|---|
|
|
149
|
-
| **Production Live Application (`PROD`)** | `https://<
|
|
150
|
-
| **Staging Live Application (`STAGING`)** | `https://<
|
|
151
|
-
| **Development Live Application (`DEV`)** | `https://<
|
|
152
|
-
| **Branch Preview URL** | `https://<
|
|
150
|
+
| **Production Live Application (`PROD`)** | `https://<site-address>.sitemills.com` | `https://gradeprep.sitemills.com` |
|
|
151
|
+
| **Staging Live Application (`STAGING`)** | `https://<site-address>-staging.sitemills.com` | `https://gradeprep-staging.sitemills.com` |
|
|
152
|
+
| **Development Live Application (`DEV`)** | `https://<site-address>-dev.sitemills.com` | `https://gradeprep-dev.sitemills.com` |
|
|
153
|
+
| **Branch Preview URL** | `https://<site-address>--<branchId>.sitemills.com/?preview_token=...` | `https://gradeprep--e4d7df82-24b2-4e3b-97ce-5aa4ba5a79ec.sitemills.com` |
|
|
153
154
|
| **Platform Project Console / IDE** | `https://sitemills.com/project/<projectId>` | `https://sitemills.com/project/gradeprep` |
|
|
154
155
|
| **Project Planning Board** | `https://sitemills.com/project/<projectId>/planning` | `https://sitemills.com/project/gradeprep/planning` |
|
|
155
156
|
| **Project Settings / Variables** | `https://sitemills.com/project/<projectId>/settings` | `https://sitemills.com/project/gradeprep/settings` |
|
|
156
157
|
|
|
157
158
|
> [!WARNING]
|
|
158
159
|
> **Important URL Distinction:**
|
|
159
|
-
> - **Live Deployed Websites**: Web applications deployed to SiteMills are hosted on subdomains: `https://<
|
|
160
|
+
> - **Live Deployed Websites**: Web applications deployed to SiteMills are hosted on subdomains of their site address: `https://<site-address>.sitemills.com` for Production, `https://<site-address>-staging.sitemills.com` for Staging, and `https://<site-address>-dev.sitemills.com` for Dev. Build site links from the site address (`sitemills-cli info` shows it), never from the project ID.
|
|
160
161
|
> - **Platform Console Dashboard**: The web dashboard is located at `https://sitemills.com/project/<projectId>` (singular `/project/`, **not** plural `/projects/`). Never link to `https://sitemills.com/projects/<projectId>` as that is an internal API route prefix (`/api/v1/projects/...`) and will fail to load in the browser.
|
|
161
162
|
|
|
162
163
|
## Preview Access Tokens & Non-Production Environments
|
|
@@ -184,7 +185,7 @@ Non-production environments (**DEV**, **STAGING**, and **Branch Previews**) are
|
|
|
184
185
|
- Their active session cookie (`USER_AUTH_TOKEN`) authorizes access directly to all permitted project environments.
|
|
185
186
|
|
|
186
187
|
4. **Production Environments (`PROD`)**:
|
|
187
|
-
- Production URLs (`https://<
|
|
188
|
+
- Production URLs (`https://<site-address>.sitemills.com`) are always public and do not require authentication or preview tokens.
|
|
188
189
|
|
|
189
190
|
---
|
|
190
191
|
|
|
@@ -262,11 +263,10 @@ sitemills-cli <command> [options]
|
|
|
262
263
|
```bash
|
|
263
264
|
sitemills-cli seed <projectName> [outputDir]
|
|
264
265
|
```
|
|
265
|
-
- **Folder commands** (`check`, `push`, `commit`, `deploy`): `[dir]` defaults to the current folder and must be a folder created by `export` or `import`. You can always pass `<projectId>
|
|
266
|
+
- **Folder commands** (`check`, `push`, `commit`, `deploy`): `[dir]` defaults to the current folder and must be a folder created by `export` or `import`. You can always pass `<projectId> [dir]` instead.
|
|
266
267
|
- **export**: Download an app's code into a folder and link the folder to the app, so `check`, `push`, `commit`, and `deploy` work inside it without IDs.
|
|
267
268
|
```bash
|
|
268
269
|
sitemills-cli export <projectId> [outputDir] # Working Draft into ./<projectId> by default
|
|
269
|
-
sitemills-cli export <projectId> <branchId> <outputDir>
|
|
270
270
|
```
|
|
271
271
|
- **commit** (or **save-snapshot**): Quickly save a code snapshot to a branch without triggering cloud compilation or tests (~100ms). Only files that differ from the remote branch are uploaded, and remote files missing locally are deleted (pass `--no-prune` to keep them). Automatically saves metadata to `.sitemills/build.json` in the local directory and records the build in `~/.sitemills/builds.json`.
|
|
272
272
|
```bash
|
|
@@ -282,7 +282,7 @@ sitemills-cli <command> [options]
|
|
|
282
282
|
```
|
|
283
283
|
- **compile**: Trigger manual project code compilation for a branch and inspect diagnostics. Pass `--skip-tests` to bypass testing.
|
|
284
284
|
```bash
|
|
285
|
-
sitemills-cli compile <projectId> [--
|
|
285
|
+
sitemills-cli compile <projectId> [--skip-tests]
|
|
286
286
|
```
|
|
287
287
|
- **deploy**: Deploy a branch to an environment (`dev`, `staging`, or `prod`).
|
|
288
288
|
```bash
|
|
@@ -294,7 +294,7 @@ sitemills-cli <command> [options]
|
|
|
294
294
|
```
|
|
295
295
|
- **version-history**: View the timeline of code versions and checkpoints for a specific branch.
|
|
296
296
|
```bash
|
|
297
|
-
sitemills-cli version-history <projectId> [
|
|
297
|
+
sitemills-cli version-history <projectId> [--limit <limit>]
|
|
298
298
|
```
|
|
299
299
|
- **delete**: Delete a project on SiteMills.
|
|
300
300
|
```bash
|
|
@@ -334,7 +334,7 @@ Manage background and scheduled jobs defined in `contracts/jobs.json` and implem
|
|
|
334
334
|
|
|
335
335
|
- **seed-db**: Seed database records for a project/branch from a JSON file.
|
|
336
336
|
```bash
|
|
337
|
-
sitemills-cli seed-db <projectId> <
|
|
337
|
+
sitemills-cli seed-db <projectId> <dataFile.json>
|
|
338
338
|
```
|
|
339
339
|
- **data-copy** (or **clone-scope**): Clone all database collections and records from a source environment/scope to a target scope (e.g. from PROD to STAGING).
|
|
340
340
|
```bash
|
|
@@ -343,7 +343,7 @@ Manage background and scheduled jobs defined in `contracts/jobs.json` and implem
|
|
|
343
343
|
```
|
|
344
344
|
- **data-op**: Execute structured database operations (query, count, seed, mutation preview, mutation apply, or inline Lua execution).
|
|
345
345
|
```bash
|
|
346
|
-
sitemills-cli data-op <projectId> <payloadJsonOrFile> [--
|
|
346
|
+
sitemills-cli data-op <projectId> <payloadJsonOrFile> [--env <environment>] [--mock-user <email>]
|
|
347
347
|
```
|
|
348
348
|
*Inline Example:*
|
|
349
349
|
```bash
|
|
@@ -362,11 +362,11 @@ Manage background and scheduled jobs defined in `contracts/jobs.json` and implem
|
|
|
362
362
|
|
|
363
363
|
- **logs**: Fetch runtime logs with optional branch, environment, and level filtering.
|
|
364
364
|
```bash
|
|
365
|
-
sitemills-cli logs <projectId> [--
|
|
365
|
+
sitemills-cli logs <projectId> [--env <environment>] [--level <INFO|WARN|ERROR>] [--limit <limit>]
|
|
366
366
|
```
|
|
367
367
|
- **workflows**: List recent AI/agentic workflows run on the project, including prompts, token consumption, and status.
|
|
368
368
|
```bash
|
|
369
|
-
sitemills-cli workflows <projectId> [--
|
|
369
|
+
sitemills-cli workflows <projectId> [--limit <limit>]
|
|
370
370
|
```
|
|
371
371
|
- **credits**: Query remaining credit and token usage balances for a project.
|
|
372
372
|
```bash
|
|
@@ -513,7 +513,6 @@ How the CLI stays current depends on how you installed it:
|
|
|
513
513
|
- `--skip-tests`: Bypass automated test suite execution during push and compilation.
|
|
514
514
|
- `--params <json>`: JSON payload parameters for on-demand job execution (`jobs run`).
|
|
515
515
|
- `--reason <reason>`: Reason message when pausing a background job (`jobs pause`).
|
|
516
|
-
- `--branch <branch>`: Target branch ID or branch data scope.
|
|
517
516
|
- `--env <environment>`: Target environment name (`DEV`, `STAGING`, or `PROD`).
|
|
518
517
|
- `--filter <filter>`: JSON query filter for `run-lua` (e.g. `'{"status":"pending"}'`).
|
|
519
518
|
- `--dry-run`: Execute Lua script as a dry run simulation without applying database writes.
|