@guestrly/cli 0.0.0-stage → 0.1.0
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 +33 -2
- package/dist/guestrly.js +8262 -0
- package/package.json +45 -4
package/README.md
CHANGED
|
@@ -1,3 +1,34 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @guestrly/cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Build a [Guestrly](https://guestrly.com) guidebook from a folder of Markdown files, by hand or with an AI agent
|
|
4
|
+
(Claude Code, Codex, Cursor…).
|
|
5
|
+
|
|
6
|
+
```sh
|
|
7
|
+
npx @guestrly/cli login --token gst_… # API key from the dashboard: Settings → API keys
|
|
8
|
+
npx @guestrly/cli init --title "Lake House" # draft guidebook with sample pages, written to ./lake-house
|
|
9
|
+
cd lake-house # edit guidebook.yaml, welcome.md and pages/*.md
|
|
10
|
+
npx @guestrly/cli push --dry-run # check
|
|
11
|
+
npx @guestrly/cli push --publish # save, upload images and go live
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Agents: run `npx @guestrly/cli guide` first. It prints the folder format, the Markdown flavour and a worked example.
|
|
15
|
+
`npx @guestrly/cli guide --agents-md` prints a snippet for your `AGENTS.md` / `CLAUDE.md`.
|
|
16
|
+
|
|
17
|
+
| Command | What it does |
|
|
18
|
+
| ------------------------------- | --------------------------------------------------------------- |
|
|
19
|
+
| `login [--token]`, `logout` | Save or forget an API key (or set `GUESTRLY_API_KEY`) |
|
|
20
|
+
| `list` | Your guidebooks |
|
|
21
|
+
| `init [dir] --title … [--handle] [--template apartment\|blank]` | Create a draft and write it to a folder |
|
|
22
|
+
| `pull [handle] [dir]` | Download a guidebook into a folder |
|
|
23
|
+
| `push [dir] [--dry-run] [--publish]` | Replace the guidebook with the folder, uploading new images |
|
|
24
|
+
| `publish`, `unpublish`, `open` | Go live, go offline, print the guest link |
|
|
25
|
+
| `guide [--agents-md]` | The format, for people and agents |
|
|
26
|
+
|
|
27
|
+
Every command accepts `--json` and never prompts when it isn't run in a terminal. Exit codes: 2 usage, 3 auth,
|
|
28
|
+
4 mistakes in the guidebook (each reported with its file).
|
|
29
|
+
|
|
30
|
+
## Developing
|
|
31
|
+
|
|
32
|
+
From the repo root: `npm run build -w @guestrly/cli`, then `node packages/cli/dist/guestrly.js --api-url
|
|
33
|
+
http://localhost:3000 …`. The API client in `src/api/generated` is Orval output: regenerate with
|
|
34
|
+
`npm run codegen -w @guestrly/cli` while the API runs on :3000.
|