deployai 0.1.0-beta.4 → 0.1.0-beta.40
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 +30 -11
- package/dist/index.js +7995 -1411
- package/package.json +5 -23
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ Website: https://deployai.co.il. For developers: https://deployai.co.il/develope
|
|
|
10
10
|
|
|
11
11
|
The easiest start is on https://deployai.co.il:
|
|
12
12
|
1. Choose a sample or "Go live now".
|
|
13
|
-
2. Copy the one line it gives you into an AI agent that can run commands in your folder (Claude Code, Cursor, GitHub Copilot in VS Code, Codex in the ChatGPT app, or
|
|
13
|
+
2. Copy the one line it gives you into an AI agent that can run commands in your folder (Claude Code, Cursor, GitHub Copilot in VS Code, Codex in the ChatGPT app, Google Antigravity, or Grok Build).
|
|
14
14
|
|
|
15
15
|
The line is `npx deployai@latest start <id>`. It carries every choice you made there, prepares the folder, and prints the steps for the agent.
|
|
16
16
|
|
|
@@ -32,34 +32,52 @@ pnpm dlx deployai check
|
|
|
32
32
|
npm i -g deployai
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Node
|
|
35
|
+
Node.js 22.12 or newer. No other setup: the CLI talks to https://deployai.co.il.
|
|
36
|
+
|
|
37
|
+
It stays up to date by itself. `npx deployai@latest` always runs the newest version. An installed copy checks npm at most once an hour, installs a newer version once into `~/.deployai/cli`, and runs every command on it. Set `DEPLOYAI_NO_UPDATE=1` to stay on the installed version; `CI` does the same.
|
|
36
38
|
|
|
37
39
|
## Commands
|
|
38
40
|
|
|
39
41
|
| Command | What it does |
|
|
40
42
|
|---------|--------------|
|
|
41
|
-
| `deployai init` | Creates `DEPLOYAI.md` (rules for the AI agent) and `.deployai/project.json`. Never edits your code and does not link a project (use `link`). `--force` overwrites `DEPLOYAI.md
|
|
43
|
+
| `deployai init` | Creates `DEPLOYAI.md` (rules for the AI agent: the stack to build with, what to avoid, how to keep existing data), adds one line pointing to it in `AGENTS.md` and `CLAUDE.md`, and `.deployai/project.json`. Run it first in a new project, even an empty folder. Never edits your code and does not link a project (use `link`). `--force` overwrites `DEPLOYAI.md`, `--no-agent-files` leaves `AGENTS.md` and `CLAUDE.md` alone. |
|
|
42
44
|
| `deployai inspect` | Shows framework, package manager, language, database, storage and the number of env files (values are never read). `--json` for machine output. |
|
|
43
45
|
| `deployai check` | Lists blockers and warnings with file and line. It answers only whether the project can run on DeployAI. More below. |
|
|
44
46
|
| `deployai login` | Logs in through the browser (device code). The token lasts 30 days and is stored in `~/.deployai/config.json` with the API address that issued it; it is never sent to another address. |
|
|
45
47
|
| `deployai logout` | Cancels the token on DeployAI and removes it from this computer. |
|
|
46
48
|
| `deployai whoami` | Shows the logged in user. |
|
|
47
49
|
| `deployai link [project]` | Links this folder to a project (slug, id or name). `--create "<name>"` makes a new project. With no name it never links on its own: in a terminal it asks first, an agent gets the exact `link <slug>` command. |
|
|
48
|
-
| `deployai deploy -m "<message>"` | Runs the check, packs the source and uploads it.
|
|
49
|
-
| `deployai versions` | Lists versions: number, live or not, status ("replaced by a newer upload" for one that never built), date, size, message, and
|
|
50
|
+
| `deployai deploy -m "<message>"` | Runs the check, packs the source and uploads it, then waits for the build. At a terminal it asks whether to put it live right away or show the preview first. `--live` puts it live after the build without asking (only on the owner's yes), `--no-wait` returns after the upload. |
|
|
51
|
+
| `deployai versions` | Lists versions: number, live or not, status ("replaced by a newer upload" for one that never built), date, size, message, and the `sql vN` command when its SQL waits for approval. |
|
|
50
52
|
| `deployai rollback v5` | Puts version 5 back live, with no rebuild. |
|
|
51
|
-
| `deployai promote v5` | Puts version 5 live. |
|
|
52
|
-
| `deployai
|
|
53
|
+
| `deployai promote v5` | Puts version 5 live. New database changes (SQL) are shown and run first, after a yes; SQL that removes data needs the database name typed. An agent passes `--approve-sql <code>` only after the owner said yes, and never for SQL that removes data. |
|
|
54
|
+
| `deployai sql v5` | The database changes version 5 runs before it goes live. |
|
|
55
|
+
| `deployai status` | Site state, address, live version, the newest version when it is not live yet (with the promote command once it is ready), and queue. When the live site is closed to the country you run this from, it says so and how to open it, or to use a VPN. |
|
|
53
56
|
| `deployai deploy --guest` | No login needed: puts the site live as a temporary site with a claim link. More below. |
|
|
54
57
|
| `deployai pull` | Downloads the code of the linked site's live version into this empty folder. Needs login. |
|
|
58
|
+
| `deployai pull --history` | The same, with the site's history as git commits, one per version up to the live one, oldest first. |
|
|
59
|
+
| `deployai migrate scan <url>` | Scans the old site you are moving: every page's address, title and description, the platform, and on WordPress its posts as Markdown. Up to 300 pages, `--max <n>` up to 1,000. Writes into `.deployai/migration/<host>/` only. |
|
|
60
|
+
| `deployai migrate media` | Downloads the old site's files at their old paths, resumable (25 MB a file, 1 GB a move). |
|
|
61
|
+
| `deployai migrate pages` | Lists every page the move keeps in the dashboard's Pages, at its old address, with the old menu. |
|
|
62
|
+
| `deployai migrate legal` | Starts the dashboard's Documents and Accessibility pages from the scan: what to look at, never marked done. Asks nothing. |
|
|
63
|
+
| `deployai migrate redirects` | Writes `public/_redirects` only for old addresses that cannot stay. |
|
|
64
|
+
| `deployai migrate verify <preview>` | Checks every old address on the preview: moved, missing, an error, or a lost title or description. |
|
|
65
|
+
| `deployai migrate status <stage> [note]` | For a managed move: reports the stage (and a note like the preview address) to the request, so the board and the owner's status page update. |
|
|
66
|
+
| `deployai brand favicon\|icons\|images` | The site's icons and share image, made by code from the site's own name, colors and logo: `favicon` gives a site with none its old icon, its logo or a letter in its color; `icons` makes every size; `images` measures every image against where it shows and changes nothing. |
|
|
67
|
+
| `deployai blocks [inbox\|blog]` | Adds one of DeployAI's building blocks to an existing site, never over a file, with a guide in `.deployai/blocks/<key>.md`. With no key it lists them. |
|
|
55
68
|
| `deployai claim` | Prints this folder's temporary site keep link again. `--email <address>` mails it, with a reminder before the delete. |
|
|
56
69
|
| `deployai samples [name] [folder]` | Lists the six sample sites, or downloads one. More below. |
|
|
57
|
-
| `deployai start <id>` | The one line copied on the DeployAI site. Prepares this folder, then prints the steps for your agent.
|
|
70
|
+
| `deployai start <id>` | The one line copied on the DeployAI site. Prepares this folder, then prints the steps for your agent. A site's line logs in first; a temporary site needs no login. More below. |
|
|
58
71
|
| `deployai speed <url>` | Google PageSpeed test of a page: lab results, real visitor data when Google has it and the biggest opportunities. `--desktop` tests a desktop load. |
|
|
59
|
-
| `deployai
|
|
72
|
+
| `deployai shot <url>` | Phone (390) and desktop (1440) pictures of a page, full page, with the Chrome or Edge already on the computer. `--webkit` uses Safari's engine. |
|
|
73
|
+
| `deployai optimize [folder]` | AVIF and WebP next to every JPG and PNG under public/, plus a phone width for wide images. Originals never change. |
|
|
74
|
+
| `deployai addons` | The marketplace add-ons of the linked site: which it has, which are done and which is next. The server checks that the site has each add-on. It runs what the site has even before the marketplace opens. |
|
|
60
75
|
| `deployai addon next` | Prints the next add-on of the site for your agent. `deployai addon run <name>` prints one by name. |
|
|
76
|
+
| `deployai addons run` | With more than one add-on waiting, prints a question for the owner. `--one-by-one` (recommended): after each add-on, the owner chooses whether to publish. `--all`: they all finish first, then one publish at the end. The owner still approves each plan. |
|
|
61
77
|
| `deployai addon done <runId>` | Saves the report of a finished add-on (`--status done\|failed\|skipped`, `--report .deployai/addon-report.json`) and prints the next one. |
|
|
62
78
|
| `deployai telemetry status\|on\|off` | Shows exactly what is sent, or turns it on or off. |
|
|
79
|
+
| `deployai sound on\|off\|status\|test` | A sound on this computer when your site is ready. Off until you say yes. |
|
|
80
|
+
| `deployai sound agent on\|off` | Claude Code only so far: a dot in the tab title and a sound when it finishes or asks you, in this folder only. `sound on` already does this inside Claude Code. Sends nothing and never reads your prompts. |
|
|
63
81
|
|
|
64
82
|
Global options:
|
|
65
83
|
- `--api <url>` (or env `DEPLOYAI_API_URL`)
|
|
@@ -90,7 +108,7 @@ Global options:
|
|
|
90
108
|
**`deployai start <id>`**
|
|
91
109
|
- The one line copied on the DeployAI site.
|
|
92
110
|
- Prepares this folder with every choice made there: a new folder for a new site when this one has files, the sample and its install, the owner's details, the link to the site. Then prints the steps for your agent.
|
|
93
|
-
-
|
|
111
|
+
- A line for a site opens only for its owner or an editor, so it logs in first if needed. A temporary site's line needs no login.
|
|
94
112
|
- It saves the owner's language, so later results print in it (D-266; `--lang he|en` or `DEPLOYAI_LANG` override it).
|
|
95
113
|
- `--here` keeps this folder, `--no-install` skips the install.
|
|
96
114
|
|
|
@@ -124,11 +142,12 @@ Never uploaded:
|
|
|
124
142
|
Sent when on:
|
|
125
143
|
|
|
126
144
|
- Install id (random, made on this computer) and CLI version
|
|
127
|
-
- After each command: command name and result (success, blocked, error category)
|
|
145
|
+
- After each command: command name and result (success, blocked, error category). A start that has to wait for a login sends one more, before it waits
|
|
128
146
|
- Linked project id, detected framework and version
|
|
129
147
|
- After each check: compatible or not, blocker and warning codes (for example `fs_write`)
|
|
130
148
|
- OS, architecture and Node version (in the request header)
|
|
131
149
|
- Your user id, only after login
|
|
150
|
+
- With each deploy, which AI tool ran it (for example Claude Code or Codex), when the environment says so
|
|
132
151
|
|
|
133
152
|
Never sent: source code or file contents, `.env` values or any secret, file paths or file names.
|
|
134
153
|
|