fimo 2.3.2-staging.2 → 2.4.0-staging.1
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/assets/skills/fimo-cli/references/deploy.md +8 -11
- package/assets/skills/fimo-cli/references/init.md +1 -1
- package/assets/skills/fimo-cli/references/integrations/firecrawl.md +1 -1
- package/assets/skills/fimo-cli/references/preview.md +12 -42
- package/dist/cli/bundle.json +1 -1
- package/dist/cli/index.js +17 -19
- package/package.json +8 -8
- package/templates/astro/package.json +2 -2
- package/templates/nextjs/package.json +3 -3
- package/templates/react-router/package.json +4 -4
- package/templates/sveltekit/package.json +2 -2
- package/templates/vite/package.json +4 -4
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
Before deploying, Fimo fast-forwards a clean checkout that is behind and stops on dirty-behind or diverged branches. This syncs the whole branch, including config commits from Studio or locale commands.
|
|
10
10
|
|
|
11
|
-
> **Just need the current preview URL?** That's `fimo preview url` — no commit or push.
|
|
11
|
+
> **Just need the current preview URL?** That's `fimo preview url` — no commit or push. It waits if the hosted generation is still building. See `references/preview.md`.
|
|
12
12
|
|
|
13
13
|
## Commands
|
|
14
14
|
|
|
@@ -19,7 +19,7 @@ fimo deploy --no-restart # skip dev-server restart (HMR-safe
|
|
|
19
19
|
fimo deploy -m "<commit message>" --publish # also publish a new live version
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
- **`fimo deploy`** — commits pending changes, pushes to the current Branch, syncs that Branch's preview sandbox, and links to
|
|
22
|
+
- **`fimo deploy`** — commits pending changes, pushes to the current Branch, syncs that Branch's preview sandbox, and links to Fimo Studio.
|
|
23
23
|
- **`fimo deploy --publish`** — same as above, then triggers a live publish and prints the live URL. Runs from the configured Production source Branch only. **Only use `--publish` when the user signals "ship it"** — first-time site completion, or an explicit "publish" / "go live" request. Otherwise stick to plain `fimo deploy`. (For a _versioned_ prod release, use `fimo publish` instead — see below.)
|
|
24
24
|
- **`-m`** is the commit message used when there are uncommitted local changes; required in non-interactive shells. Omit if the working tree is already clean.
|
|
25
25
|
- **`--no-restart`** — tells the sandbox to skip the dev-server restart and let Vite HMR pick up the change. Shaves ~3s per deploy. See "Skipping the dev-server restart" below for when it's safe.
|
|
@@ -35,16 +35,13 @@ fimo deploy -m "<commit message>" --publish --json
|
|
|
35
35
|
|
|
36
36
|
Read these fields from `data`:
|
|
37
37
|
|
|
38
|
-
| Field
|
|
39
|
-
|
|
|
40
|
-
| `
|
|
41
|
-
| `
|
|
42
|
-
| `
|
|
43
|
-
| `studio_url` | Stable, authenticated Fimo Studio project and Branch page. |
|
|
44
|
-
| `dashboard_url` | Deprecated compatibility alias for `studio_url`. |
|
|
45
|
-
| `app_url` | Public live site, returned after a successful `--publish`. |
|
|
38
|
+
| Field | Destination |
|
|
39
|
+
| --------------- | ---------------------------------------------------------- |
|
|
40
|
+
| `studio_url` | Stable Fimo Studio project and Branch page. |
|
|
41
|
+
| `dashboard_url` | Deprecated compatibility alias for `studio_url`. |
|
|
42
|
+
| `app_url` | Public live site, returned after a successful `--publish`. |
|
|
46
43
|
|
|
47
|
-
When reporting the result,
|
|
44
|
+
When reporting the result, give the user `studio_url`. If a person or tool needs the hosted site itself, run `fimo preview url` after deploy.
|
|
48
45
|
|
|
49
46
|
Public project variables managed with `fimo vars add` and `fimo vars update` are injected into preview/build/deploy runtimes. Project secrets are not injected into app builds; agents request secrets separately through their own config. See `references/project-vars-and-secrets.md`.
|
|
50
47
|
|
|
@@ -165,7 +165,7 @@ Whenever `fimo init` created or scaffolded a new project — including a Studio-
|
|
|
165
165
|
fimo deploy -m "chore: first preview" --json
|
|
166
166
|
```
|
|
167
167
|
|
|
168
|
-
`-m` is required because you run non-interactively; the deploy validates, commits pending changes, pushes, and syncs the
|
|
168
|
+
`-m` is required because you run non-interactively; the deploy validates, commits pending changes, pushes, and syncs the preview sandbox. Return `data.studio_url` from the envelope. Run `fimo preview url --json` only when the hosted site URL itself is needed. If the initiating request described a concrete site, build a minimal meaningful first screen before this single deploy; otherwise deploy the scaffolded site as-is and then ask what to build.
|
|
169
169
|
|
|
170
170
|
This first deploy creates a preview only — never add `--publish`, and treat every later deploy as offer-then-confirm. The rule does not apply when `init` cloned a project with existing code or when the work is a migration; those paths keep their normal deployment approval rules.
|
|
171
171
|
|
|
@@ -228,4 +228,4 @@ Visual/content QA before publish:
|
|
|
228
228
|
fimo integrations run firecrawl scrape --url "$(fimo preview url)" --formats markdown,links --json
|
|
229
229
|
```
|
|
230
230
|
|
|
231
|
-
|
|
231
|
+
`fimo preview url` emits the hosted deployment URL in this example. In JSON workflows, pass `data.preview_url` to Firecrawl.
|
|
@@ -1,27 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Hosted preview URL
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
`fimo deploy` commits, pushes, and syncs the sandbox before it prints destinations. `fimo preview url` skips those deployment steps and only resolves the current Branch's preview destinations.
|
|
6
|
-
|
|
7
|
-
## Commands
|
|
3
|
+
Use `fimo preview url` to get the current Branch's hosted preview without committing or pushing.
|
|
8
4
|
|
|
9
5
|
```bash
|
|
10
|
-
fimo preview url
|
|
11
|
-
fimo --branch feat/redesign preview url
|
|
12
|
-
fimo preview url --branch main --json
|
|
13
|
-
fimo preview url
|
|
14
|
-
curl -L "$(fimo preview url)" # fetch the raw sandbox preview
|
|
6
|
+
fimo preview url
|
|
7
|
+
fimo --branch feat/redesign preview url
|
|
8
|
+
fimo preview url --branch main --json
|
|
9
|
+
curl -L "$(fimo preview url)"
|
|
15
10
|
```
|
|
16
11
|
|
|
17
|
-
|
|
12
|
+
The command returns the hosted deployment URL in every output mode, whatever the project's Preview setting says: every live Branch except production owns a hosted build.
|
|
18
13
|
|
|
19
|
-
|
|
14
|
+
If the current generation is queued or building, the command waits up to five minutes, polling with a backoff. It stops at once — without waiting — on a state waiting cannot change: a build that failed, and a Branch with no hosted preview (production, or a Branch nothing has changed yet). Every failure returns `PREVIEW_URL_FAILED`; read `error.message` for which one it was and `error.hint` for the next step. Only the timeout is worth retrying.
|
|
20
15
|
|
|
21
|
-
|
|
22
|
-
- **Piped or captured output:** prints only the short-lived `sandbox_url`. This preserves commands such as `curl -L "$(fimo preview url)"` and gives browsers, screenshot tools, and crawlers the directly fetchable site.
|
|
23
|
-
- **`--all`:** prints `preview_url`, `studio_url`, `sandbox_url`, and `sandbox_expires_at` as named raw values for a person inspecting every destination.
|
|
24
|
-
- **JSON mode** (or `FIMO_OUTPUT=json`): returns both destinations explicitly:
|
|
16
|
+
JSON output contains only the Branch identity and hosted URL:
|
|
25
17
|
|
|
26
18
|
```json
|
|
27
19
|
{
|
|
@@ -32,33 +24,11 @@ curl -L "$(fimo preview url)" # fetch the raw sandbox pre
|
|
|
32
24
|
"project_id": "prj_abc",
|
|
33
25
|
"branch": "main",
|
|
34
26
|
"env": "main",
|
|
35
|
-
"preview_url": "https://fimo.
|
|
36
|
-
"sandbox_url": "https://preview.provider.example/session",
|
|
37
|
-
"sandbox_expires_at": "2026-08-20T18:42:00.000Z",
|
|
38
|
-
"studio_url": "https://fimo.ai/app/projects/prj_abc/branch/main/preview",
|
|
39
|
-
"dashboard_url": "https://fimo.ai/app/projects/prj_abc/branch/main/preview"
|
|
27
|
+
"preview_url": "https://fimo-preview-example.vercel.app"
|
|
40
28
|
}
|
|
41
29
|
}
|
|
42
30
|
```
|
|
43
31
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
## When to use it
|
|
47
|
-
|
|
48
|
-
- **You deployed a change and want to inspect it** — open the interactive `preview_url`.
|
|
49
|
-
- **An agent or tool needs to read the site** — pipe the command or use `data.sandbox_url` from JSON.
|
|
50
|
-
- **The raw URL expired** — run `fimo preview url` again; do not redeploy.
|
|
51
|
-
|
|
52
|
-
## When NOT to use it
|
|
53
|
-
|
|
54
|
-
- **You changed code and want it on the preview** — use `fimo deploy`. This command only retrieves destinations.
|
|
55
|
-
- **You need the live published URL** — use `fimo deploy --publish` or `fimo publish`; see `references/deploy.md` and `references/domains.md`.
|
|
56
|
-
|
|
57
|
-
## Cold sandbox case
|
|
58
|
-
|
|
59
|
-
Resolving `sandbox_url` may take roughly 60–90 seconds when an idle sandbox must be provisioned or restarted. The stable `preview_url` performs the same authenticated resolution when a project member opens it.
|
|
60
|
-
|
|
61
|
-
## See also
|
|
32
|
+
Use `fimo deploy` when code still needs to be pushed. Use `fimo deploy --publish` or `fimo publish` only when the site should go live.
|
|
62
33
|
|
|
63
|
-
|
|
64
|
-
- `references/branches.md` — Branch semantics and the global `--branch <name>` flag.
|
|
34
|
+
See `references/deploy.md` for deployment and `references/branches.md` for Branch selection.
|