deployai 0.1.0-beta.2 → 0.1.0-beta.21
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 +26 -13
- package/dist/index.js +3326 -443
- package/package.json +33 -15
package/README.md
CHANGED
|
@@ -38,26 +38,36 @@ Node 20 or newer. No other setup: the CLI talks to https://deployai.co.il.
|
|
|
38
38
|
|
|
39
39
|
| Command | What it does |
|
|
40
40
|
|---------|--------------|
|
|
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
|
|
41
|
+
| `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
42
|
| `deployai inspect` | Shows framework, package manager, language, database, storage and the number of env files (values are never read). `--json` for machine output. |
|
|
43
43
|
| `deployai check` | Lists blockers and warnings with file and line. It answers only whether the project can run on DeployAI. More below. |
|
|
44
|
-
| `deployai login` | Logs in through the browser (device code). The token is stored in `~/.deployai/config.json
|
|
45
|
-
| `deployai logout` |
|
|
44
|
+
| `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
|
+
| `deployai logout` | Cancels the token on DeployAI and removes it from this computer. |
|
|
46
46
|
| `deployai whoami` | Shows the logged in user. |
|
|
47
|
-
| `deployai link [project]` | Links this folder to a project (slug, id or name). `--create "<name>"` makes a new project. |
|
|
48
|
-
| `deployai deploy -m "<message>"` | Runs the check, packs the source and uploads it.
|
|
49
|
-
| `deployai versions` | Lists versions: number, live or not, status, date, size, message. |
|
|
47
|
+
| `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, 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. |
|
|
49
|
+
| `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
50
|
| `deployai rollback v5` | Puts version 5 back live, with no rebuild. |
|
|
51
|
-
| `deployai promote v5` | Puts version 5 live. |
|
|
52
|
-
| `deployai
|
|
51
|
+
| `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. |
|
|
52
|
+
| `deployai sql v5` | The database changes version 5 runs before it goes live. |
|
|
53
|
+
| `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. |
|
|
53
54
|
| `deployai deploy --guest` | No login needed: puts the site live as a temporary site with a claim link. More below. |
|
|
54
55
|
| `deployai pull` | Downloads the code of the linked site's live version into this empty folder. Needs login. |
|
|
56
|
+
| `deployai pull --history` | The same, with the site's history as git commits, one per version up to the live one, oldest first. |
|
|
57
|
+
| `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. |
|
|
58
|
+
| `deployai migrate media` | Downloads the old site's files at their old paths, resumable (25 MB a file, 1 GB a move). |
|
|
59
|
+
| `deployai migrate redirects` | Writes `public/_redirects` only for old addresses that cannot stay. |
|
|
60
|
+
| `deployai migrate verify <preview>` | Checks every old address on the preview: moved, missing, an error, or a lost title or description. |
|
|
61
|
+
| `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. |
|
|
62
|
+
| `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. |
|
|
63
|
+
| `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
64
|
| `deployai claim` | Prints this folder's temporary site keep link again. `--email <address>` mails it, with a reminder before the delete. |
|
|
56
65
|
| `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.
|
|
66
|
+
| `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
67
|
| `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
68
|
| `deployai addons` | The marketplace add-ons of the linked site: which it has, which are done and which is next. Works once the DeployAI marketplace is open; the server checks that the site has each add-on. |
|
|
60
69
|
| `deployai addon next` | Prints the next add-on of the site for your agent. `deployai addon run <name>` prints one by name. |
|
|
70
|
+
| `deployai addons run` | Runs every add-on the site has that is not done, one after the other, with no ask between them. |
|
|
61
71
|
| `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
72
|
| `deployai telemetry status\|on\|off` | Shows exactly what is sent, or turns it on or off. |
|
|
63
73
|
|
|
@@ -78,6 +88,7 @@ Global options:
|
|
|
78
88
|
**`deployai deploy --guest`**
|
|
79
89
|
- No login needed: puts the site live as a temporary site with a claim link, deleted after the days DeployAI sets unless you claim it.
|
|
80
90
|
- A temporary site may have a small database, but no file storage or environment variables.
|
|
91
|
+
- A folder linked to a site in an account refuses: run `login`, then `deploy`.
|
|
81
92
|
- For a database sample it prints the site's owner keys once ("shown once, save them now"). They are never stored, so save them right away.
|
|
82
93
|
|
|
83
94
|
**`deployai samples [name] [folder]`**
|
|
@@ -89,7 +100,7 @@ Global options:
|
|
|
89
100
|
**`deployai start <id>`**
|
|
90
101
|
- The one line copied on the DeployAI site.
|
|
91
102
|
- 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.
|
|
92
|
-
-
|
|
103
|
+
- 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.
|
|
93
104
|
- It saves the owner's language, so later results print in it (D-266; `--lang he|en` or `DEPLOYAI_LANG` override it).
|
|
94
105
|
- `--here` keeps this folder, `--no-install` skips the install.
|
|
95
106
|
|
|
@@ -111,9 +122,11 @@ The default is `https://deployai.co.il`. The order is: `--api <url>`, then env `
|
|
|
111
122
|
The source folder, packed as a `.tar.gz`. The upload is capped at 50 MB.
|
|
112
123
|
|
|
113
124
|
Never uploaded:
|
|
114
|
-
- `node_modules`, `.git`,
|
|
125
|
+
- `node_modules`, `.git`, and tool caches like `.next`, `.astro`, `.svelte-kit`, `.wrangler`
|
|
126
|
+
- `dist`, `build`, `out` at the project root when `package.json` has a build script (DeployAI builds them again). Folders like `assets/build/` are uploaded.
|
|
127
|
+
- `.deployai/`, `DEPLOYAI.md`, `CLAUDE.md`, `AGENTS.md`, `.claude/`, `.cursor/`, `.vscode/` and other dotfiles (except `.well-known/` and build config like `.babelrc`). DeployAI never serves these either, however they arrive.
|
|
115
128
|
- Any `.env*` file
|
|
116
|
-
- Anything
|
|
129
|
+
- Anything in the root `.gitignore` or in `.deployaiignore` (gitignore style, read last, so `!file` brings a file back)
|
|
117
130
|
- Files over 10 MB
|
|
118
131
|
|
|
119
132
|
## Telemetry
|
|
@@ -143,4 +156,4 @@ pnpm --filter ./packages/cli start -- check
|
|
|
143
156
|
- `@deployai/shared` and `zod` are bundled into `dist/index.js` by tsup, so the published package depends only on `commander`.
|
|
144
157
|
- The package ships only `dist` and this README (check with `npm pack --dry-run`).
|
|
145
158
|
- Publish from this folder with `pnpm publish`: `prepublishOnly` builds and runs the tests first.
|
|
146
|
-
-
|
|
159
|
+
- On npm as `deployai`: run it with `npx deployai@latest <command>`.
|