sitemills-cli 1.0.12 → 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 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 <projectId> # 3. download it into ./<projectId>
113
- cd <projectId>
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://<projectId>.sitemills.com` | `https://gradeprep.sitemills.com` |
150
- | **Staging Live Application (`STAGING`)** | `https://<projectId>-staging.sitemills.com` | `https://gradeprep-staging.sitemills.com` |
151
- | **Development Live Application (`DEV`)** | `https://<projectId>-dev.sitemills.com` | `https://gradeprep-dev.sitemills.com` |
152
- | **Branch Preview URL** | `https://<projectId>--<branchId>.sitemills.com/?preview_token=...` | `https://gradeprep--e4d7df82-24b2-4e3b-97ce-5aa4ba5a79ec.sitemills.com` |
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://<projectId>.sitemills.com` for Production, `https://<projectId>-staging.sitemills.com` for Staging, and `https://<projectId>-dev.sitemills.com` for Dev.
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://<projectId>.sitemills.com`) are always public and do not require authentication or preview tokens.
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