@plaiful/cli 0.15.0 → 0.16.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.
Files changed (4) hide show
  1. package/README.md +179 -158
  2. package/package.json +21 -21
  3. package/src/cli.js +2164 -1751
  4. package/src/models.js +282 -35
package/README.md CHANGED
@@ -1,158 +1,179 @@
1
- # The Plaiful CLI
2
-
3
- > `plaiful` is how your team, or your coding agent, works on your Plaiful product from your game's repo. **Part 1**
4
- > is for the people on your team. **Part 2** is for your coding agent: every command.
5
-
6
- ## Part 1: for your team
7
-
8
- ### What it is
9
-
10
- - A command-line tool for your Plaiful product: you type commands in a terminal, in your game's repo.
11
- - It loads your data into Plaiful, reads back what Plaiful has, and reads the platform docs.
12
- - It signs in as your CMS account, so it can only see and change your own products.
13
- - It needs no AWS access.
14
- - It works in your development environment. Staging and production get your content when you promote.
15
-
16
- ### Install it and sign in
17
-
18
- You need Node 18 or later.
19
-
20
- ```sh
21
- npm install -g @plaiful/cli
22
- plaiful login
23
- ```
24
-
25
- - `plaiful login` opens the CMS. Check the code matches, and approve. The sign-in lasts 12 hours.
26
- - You need to be on Plaiful's allowlist, and own your product or have it shared with you.
27
-
28
- ### What you'll use it for
29
-
30
- | To | Run |
31
- |---|---|
32
- | Get your game's repo | `plaiful clone <product>`, or `plaiful init <product>` in a repo you already have |
33
- | Get your product's settings | `plaiful docs pull` |
34
- | Read the docs | `plaiful docs`, `plaiful docs search <words>` |
35
- | Load your world into Plaiful | `plaiful seed world`, then `plaiful seed world --apply` (and `lore`, `map`, `personas`) |
36
- | See what Plaiful has | `plaiful status`, `plaiful quests`, `plaiful lore`, `plaiful world`, `plaiful assets` |
37
- | Get a cinematic script for a world event | `plaiful events script write <eventId> --wait`, then `plaiful events script export <eventId> --fountain` |
38
- | Animate characters: a set of sprite sheets (idle, attacks, hurt, poses, a walk sheet) per record | `plaiful animation sets`, then `plaiful animation run <set> <agent> --all` |
39
- | Publish your OVID declaration | `plaiful ovid check`, then `plaiful ovid publish` |
40
- | Tell HERMES your studio's strategy | `plaiful hermes strategy check`, then `plaiful hermes strategy publish` (your studio's admins) |
41
- | Deploy and run worker agents | `plaiful agents deploy`, `plaiful agents run <name>` |
42
-
43
- Every load starts as a dry run: it shows what would change, and changes nothing until you add `--apply`.
44
-
45
- ### Keys for coding agents and CI
46
-
47
- - A coding agent working on its own, or a CI job, can use a key instead of a sign-in.
48
- - Your product's owner makes one in the CMS: **DevOps → Deployment → your product → CLI keys**.
49
- - A key works on one product, for the jobs you pick, and stops the moment you revoke it.
50
- - Keep it out of your repo.
51
-
52
- ## Part 2: for your coding agent
53
-
54
- Every command runs as the signed-in CMS account (or a product API key that account issued), on that account's
55
- products, in **dev**.
56
-
57
- ### Commands
58
-
59
- ```sh
60
- plaiful login # opens the CMS: check the code matches, approve. 12 hours.
61
- plaiful clone roadforge # clone the game repo, write .env.development, docs pull, npm install, open Zed
62
- plaiful init roadforge # (a repo you already have) writes .plaiful.json (commit it; no secrets) and makes the resources/ folders
63
- plaiful docs # the platform docs, live (docs read <doc>, docs search <words>, docs changes)
64
- plaiful docs pull # your client-config.md into docs/plaiful/ (--copies: local copies of the docs too)
65
- plaiful mcp # the docs as MCP tools for your coding assistant: claude mcp add plaiful -- plaiful mcp
66
- plaiful env # rewrite .env.development from the dev client config (keeps your own lines)
67
- plaiful ovid check # checks docs/plaiful/roadforge-ovid-declaration.json
68
- plaiful ovid publish # checks it again and publishes it; OVID reads it within ~5 minutes
69
- plaiful ovid show # what OVID has now
70
- plaiful seed world # dry run: what resources/world/roadforge/*.json make, and what changes in dev
71
- plaiful seed world --apply # write it (then lore, then map); --reset also puts the clock, reveals and NPC bindings back
72
- plaiful seed personas # THESPIS personas and situations from resources/personas/roadforge/ (same dry run / --apply)
73
- plaiful status # what OVID and THESPIS have in dev: counts per store, the clock, the declaration
74
- plaiful assets # per agent: records, and how many have art made / pending / failed / none yet
75
- plaiful assets crew-portrait --state failed # one agent's records: state, why a render failed, where the files are
76
- plaiful assets battlefield --json # also: any step that failed ({step}_step_error), and a part's source_crop and depth_min / depth_max
77
- plaiful assets regenerate battlefield --state step_failed --steps depth # re-run a step (or, without --steps, re-render: a new picture)
78
- plaiful assets regenerate building --state no_model --model # a 3D model from each record's picture (a 2d+3d Art Style; Regenerate → 3D model)
79
- plaiful quests # the quests OVID wrote: steps, and what each pays (--track, --series); quests show <id>
80
- plaiful lore # the lore sets (lore show <setId>: a set's snippets)
81
- plaiful world # the world's states and events in story order, and the clock
82
- plaiful events script write y1-s2-m1-the-object-ev-the-recovery --wait # OVID writes the event's cinematic (a draft)
83
- plaiful events script get y1-s2-m1-the-object-ev-the-recovery # the screenplay page, the versions, Soter's flags
84
- plaiful events script export y1-s2-m1-the-object-ev-the-recovery --vo --out recovery-vo.csv # the voice-over sheet
85
- plaiful events script approve y1-s2-m1-the-object-ev-the-recovery 2 # the version the game gets (--retire withdraws it)
86
- plaiful events storyboard draw y1-s2-m1-the-object-ev-the-recovery --style ink-wash --wait # a frame per shot
87
- plaiful events storyboard get y1-s2-m1-the-object-ev-the-recovery --out boards/ # the frames, saved as PNGs
88
- plaiful events edit y1-s2-m1-the-object-ev-the-recovery --title "The Recovery" # or --description, --order, --directives f.json
89
- plaiful events delete <eventId> # and quests delete <questId>; --force for official canon
90
- plaiful lore add the-sundered-wake --narrative "…" # lore reveal|hide <snippetId>, lore remove <setId>
91
- plaiful world set kessel_well false --reason "raided" # world truth|faction|var add new ones
92
- plaiful canon event <eventId> official
93
- plaiful animation sets # the animation sets you can use (sets show <id>: its states)
94
- plaiful animation sets save # save your own sets from resources/animation/roadforge/*.json (sets delete <id>)
95
- plaiful animation run creature crew-portrait --all # a set on an agent's records: one sprite sheet per state
96
- plaiful agents # your product's SmartBuilder agents in dev (agents show <name>: one agent's config)
97
- plaiful agents deploy # deploy or redeploy every config in resources/agents/roadforge/ (or name the files)
98
- plaiful agents run crew-portrait role=medic # make one record (placeholder values as key=value)
99
- plaiful agents batch crew-portrait --count 20 # start a batch (or a batch body file) → a job id
100
- plaiful agents status crew-portrait <jobId> # a batch's progress
101
- plaiful records import crew-portrait # dry run: records you wrote (resources/records/roadforge/crew-portrait.json)
102
- # into the agent's table; --apply writes them, --no-render skips the art
103
- plaiful lists # the product's SSM lists
104
- plaiful lists set shop_type tavern blacksmith healer # write one (lists get shop_type reads it)
105
- plaiful midas check # check docs/plaiful/roadforge-midas-declaration.json (publish: plaiful midas publish; show)
106
- plaiful midas health # MIDAS's analysis, per kind (balance: what's flagged; proposals; assess: run it now)
107
- plaiful midas wallet <uid> # a player's balances and history (wallet "platform"); midas ledger check <file>: a report's dry run
108
- plaiful midas pricing # what each quest pays, in your reward kinds (MIDAS); delivered in the quest's rewards
109
- plaiful midas pricing set scrap --base 20 --per-effort 10 # price a kind (unset <kind>, weight <step> <n>, apply [file])
110
- plaiful hermes strategy check # check docs/plaiful/hermes-strategy.json (publish: your studio's admins; no word: what HERMES has)
111
- plaiful upload ovid-map-biomes-tiles.json ovid-map-kingdoms-tiles.json ovid-map-colors.json # map tiles → map-data/
112
- plaiful whoami # who you are (or which key), and your products
113
- plaiful logout
114
- ```
115
-
116
- `plaiful help` lists every command and option.
117
-
118
- ### Notes
119
-
120
- - `--json` on any command prints the platform's answer as JSON (for agents). Exit codes: `0` done, `1` the platform
121
- said no (invalid, not allowed, not signed in), `2` the command itself was wrong.
122
- - Everything works in **dev**. Staging and prod get your content through Plaiful's promotion.
123
- - `docs pull` keeps `client-config.md` (your keys) out of git with `docs/plaiful/.gitignore`, and prints the
124
- `git rm --cached` line if it was committed before.
125
- - `clone` needs access to the repo on GitHub (git signed in: `gh auth login` or Git Credential Manager), and
126
- `npm install` needs npm access to the `@plaiful` packages. It writes `.env.development` only when the repo has the
127
- web template's `.env.development.example`.
128
- - `lists set` writes a StringList in your product's namespace. It won't touch a key (SecureString), a setting (a plain
129
- String), or `access/*` (who may play).
130
- - The sign-in is kept in `~/.plaiful/credentials`, never in the repo. `PLAIFUL_API_URL` or `--api` points at another API.
131
- - You need to be on the Plaiful allowlist, and own or be shared the product (Plaiful staff: every product).
132
- - From a PlaifulCMS checkout instead of npm: `npm install -g <path to PlaifulCMS>/packages/plaiful-cli`. The package
133
- is public on npmjs.com; it holds no secrets, and everything it does needs a CMS sign-in or a key.
134
-
135
- ### Keys for agents and CI
136
-
137
- A product's owner issues keys in the CMS: Product deployment → the product → **CLI keys**. A key is shown once; set
138
- it as `PLAIFUL_TOKEN` in CI or the agent's environment (never in the repo) and the CLI uses it instead of a sign-in:
139
-
140
- ```sh
141
- PLAIFUL_TOKEN=plf_k_… plaiful seed world --apply
142
- ```
143
-
144
- A key acts as the owner who issued it, on that one product, in dev, for the scopes picked (`docs`, `status`, `seed`,
145
- `ovid:publish`, `lists`, `upload`). Revoking it in the CMS stops it at once; so does its issuer losing the product. The
146
- same screen shows the product's activity: everything the CLI and its keys did.
147
-
148
- ### For Plaiful staff
149
-
150
- - **Design:** `docs/system/product/PARTNER_API_AND_CLI.md`.
151
- - **Publishing a new version:** bump `version` in `package.json`, then `npm publish` from this folder, signed in to
152
- npm as a member of the `plaiful` org.
153
- - **Tests:** the end-to-end tests run this CLI against the partner API handler:
154
- `lambda/functions/partner-api/__tests__/partner-api.test.js`.
155
- - **The model registry (`plaiful models`, staff only):** publish release cards with their files, push training data,
156
- and run GPU training on Google Cloud (`models train`, with your own `gcloud` sign-in). Guide:
157
- `docs/design/model-registry.md`; card format: `docs/design/model-card.md`. Tests:
158
- `lambda/functions/partner-api/__tests__/models.test.js` and `models-cli.test.js`.
1
+ # The Plaiful CLI
2
+
3
+ > `plaiful` is how your team, or your coding agent, works on your Plaiful product from your game's repo. **Part 1**
4
+ > is for the people on your team. **Part 2** is for your coding agent: every command.
5
+
6
+ ## Part 1: for your team
7
+
8
+ ### What it is
9
+
10
+ - A command-line tool for your Plaiful product: you type commands in a terminal, in your game's repo.
11
+ - It loads your data into Plaiful, reads back what Plaiful has, and reads the platform docs.
12
+ - It signs in as your CMS account, so it can only see and change your own products.
13
+ - It needs no AWS access.
14
+ - It works in your development environment. Staging and production get your content when you promote.
15
+
16
+ ### Install it and sign in
17
+
18
+ You need Node 18 or later.
19
+
20
+ ```sh
21
+ npm install -g @plaiful/cli
22
+ plaiful login
23
+ ```
24
+
25
+ - `plaiful login` opens the CMS. Check the code matches, and approve. The sign-in lasts 12 hours.
26
+ - You need to be on Plaiful's allowlist, and own your product or have it shared with you.
27
+
28
+ ### What you'll use it for
29
+
30
+ | To | Run |
31
+ |---|---|
32
+ | Get your game's repo | `plaiful clone <product>`, or `plaiful init <product>` in a repo you already have |
33
+ | Get your product's settings | `plaiful docs pull` |
34
+ | Read the docs | `plaiful docs`, `plaiful docs search <words>` |
35
+ | Load your world into Plaiful | `plaiful seed world`, then `plaiful seed world --apply` (and `lore`, `map`, `personas`) |
36
+ | See what Plaiful has | `plaiful status`, `plaiful quests`, `plaiful lore`, `plaiful world`, `plaiful assets` |
37
+ | Get a cinematic script for a world event | `plaiful events script write <eventId> --wait`, then `plaiful events script export <eventId> --fountain` |
38
+ | Animate characters: a set of sprite sheets (idle, attacks, hurt, poses, a walk sheet) per record | `plaiful animation sets`, then `plaiful animation run <set> <agent> --all` |
39
+ | Make or change an art style, and its reference images | `plaiful styles save` (a dry run), then `--apply`; `plaiful styles images add <id> <images>` |
40
+ | Publish your OVID declaration | `plaiful ovid check`, then `plaiful ovid publish` |
41
+ | Tell HERMES your studio's strategy | `plaiful hermes strategy check`, then `plaiful hermes strategy publish` (your studio's admins) |
42
+ | Run your studio's team | `plaiful studio show`, `plaiful studio invite <email> --role artist`, `plaiful studio remove <email>` (your studio's admins) |
43
+ | Deploy and run worker agents | `plaiful agents deploy`, `plaiful agents run <name>` |
44
+
45
+ Every load starts as a dry run: it shows what would change, and changes nothing until you add `--apply`.
46
+
47
+ ### Keys for coding agents and CI
48
+
49
+ - A coding agent working on its own, or a CI job, can use a key instead of a sign-in.
50
+ - Your product's owner makes one in the CMS: **DevOps → Deployment → your product → CLI keys**.
51
+ - A key works on one product, for the jobs you pick, and stops the moment you revoke it.
52
+ - Keep it out of your repo.
53
+
54
+ ## Part 2: for your coding agent
55
+
56
+ Every command runs as the signed-in CMS account (or a product API key that account issued), on that account's
57
+ products, in **dev**.
58
+
59
+ ### Commands
60
+
61
+ ```sh
62
+ plaiful login # opens the CMS: check the code matches, approve. 12 hours.
63
+ plaiful clone my-game # clone the game repo, write .env.development, docs pull, npm install, open Zed
64
+ plaiful init my-game # (a repo you already have) writes .plaiful.json (commit it; no secrets) and makes the resources/ folders
65
+ plaiful docs # the platform docs, live (docs read <doc>, docs search <words>, docs changes)
66
+ plaiful docs pull # your client-config.md into docs/plaiful/ (--copies: local copies of the docs too)
67
+ plaiful mcp # the docs as MCP tools for your coding assistant: claude mcp add plaiful -- plaiful mcp
68
+ plaiful env # rewrite .env.development from the dev client config (keeps your own lines)
69
+ plaiful ovid check # checks docs/plaiful/my-game-ovid-declaration.json
70
+ plaiful ovid publish # checks it again and publishes it; OVID reads it within ~5 minutes
71
+ plaiful ovid show # what OVID has now
72
+ plaiful seed world # dry run: what resources/world/my-game/*.json make, and what changes in dev
73
+ plaiful seed world --apply # write it (then lore, then map); --reset also puts the clock, reveals and NPC bindings back
74
+ plaiful seed personas # THESPIS personas and situations from resources/personas/my-game/ (same dry run / --apply)
75
+ plaiful status # what OVID and THESPIS have in dev: counts per store, the clock, the declaration
76
+ plaiful assets # per agent: records, and how many have art made / pending / failed / none yet
77
+ plaiful assets crew-portrait --state failed # one agent's records: state, why a render failed, where the files are
78
+ plaiful assets battlefield --json # also: any step that failed ({step}_step_error), and a part's source_crop and depth_min / depth_max
79
+ plaiful assets regenerate battlefield --state step_failed --steps depth # re-run a step (or, without --steps, re-render: a new picture)
80
+ plaiful assets regenerate building --state no_model --model # a 3D model from each record's picture (a 2d+3d Art Style; Regenerate → 3D model)
81
+ plaiful quests # the quests OVID wrote: steps, and what each pays (--track, --series); quests show <id>
82
+ plaiful lore # the lore sets (lore show <setId>: a set's snippets)
83
+ plaiful world # the world's states and events in story order, and the clock
84
+ plaiful events script write y1-s2-m1-the-object-ev-the-recovery --wait # OVID writes the event's cinematic (a draft)
85
+ plaiful events script get y1-s2-m1-the-object-ev-the-recovery # the screenplay page, the versions, Soter's flags
86
+ plaiful events script export y1-s2-m1-the-object-ev-the-recovery --vo --out recovery-vo.csv # the voice-over sheet
87
+ plaiful events script approve y1-s2-m1-the-object-ev-the-recovery 2 # the version the game gets (--retire withdraws it)
88
+ plaiful events storyboard draw y1-s2-m1-the-object-ev-the-recovery --style ink-wash --wait # a frame per shot
89
+ plaiful events storyboard get y1-s2-m1-the-object-ev-the-recovery --out boards/ # the frames, saved as PNGs
90
+ plaiful events edit y1-s2-m1-the-object-ev-the-recovery --title "The Recovery" # or --description, --order, --directives f.json
91
+ plaiful events delete <eventId> # and quests delete <questId>; --force for official canon
92
+ plaiful lore add the-sundered-wake --narrative "…" # lore reveal|hide <snippetId>, lore remove <setId>
93
+ plaiful world set kessel_well false --reason "raided" # world truth|faction|var add new ones
94
+ plaiful canon event <eventId> official
95
+ plaiful animation sets # the animation sets you can use (sets show <id>: its states)
96
+ plaiful animation sets save # save your own sets from resources/animation/my-game/*.json (sets delete <id>)
97
+ plaiful animation run creature crew-portrait --all # a set on an agent's records: one sprite sheet per state
98
+ plaiful styles # the art styles you can use: Plaiful's shared ones (read-only) and yours
99
+ plaiful styles show style-default --out resources/styles/my-game/my-ink.json # start from one (change its id)
100
+ plaiful styles save # dry run: what resources/styles/my-game/*.json would create or change (--apply saves)
101
+ plaiful styles images add my-ink ref1.png ref2.jpg # reference images for one of yours (images remove <id> <key>)
102
+ plaiful agents # your product's SmartBuilder agents in dev (agents show <name>: one agent's config)
103
+ plaiful agents deploy # deploy or redeploy every config in resources/agents/my-game/ (or name the files)
104
+ plaiful agents run crew-portrait role=medic # make one record (placeholder values as key=value)
105
+ plaiful agents batch crew-portrait --count 20 # start a batch (or a batch body file) → a job id
106
+ plaiful agents status crew-portrait <jobId> # a batch's progress
107
+ plaiful records import crew-portrait # dry run: records you wrote (resources/records/my-game/crew-portrait.json)
108
+ # into the agent's table; --apply writes them, --no-render skips the art
109
+ plaiful lists # the product's SSM lists
110
+ plaiful lists set shop_type tavern blacksmith healer # write one (lists get shop_type reads it)
111
+ plaiful midas check # check docs/plaiful/my-game-midas-declaration.json (publish: plaiful midas publish; show)
112
+ plaiful midas health # MIDAS's analysis, per kind (balance: what's flagged; proposals; assess: run it now)
113
+ plaiful midas wallet <uid> # a player's balances and history (wallet "platform"); midas ledger check <file>: a report's dry run
114
+ plaiful midas pricing # what each quest pays, in your reward kinds (MIDAS); delivered in the quest's rewards
115
+ plaiful midas pricing set scrap --base 20 --per-effort 10 # price a kind (unset <kind>, weight <step> <n>, apply [file])
116
+ plaiful hermes strategy check # check docs/plaiful/hermes-strategy.json (publish: your studio's admins; no word: what HERMES has)
117
+ plaiful studio list # your studios, and your role in each
118
+ plaiful studio show # your studio's people and products (admins also see invites, seats and the presets)
119
+ plaiful studio invite sam@example.com --role artist --products my-game # prints the invite link to send them
120
+ plaiful studio invite lee@example.com --role admin # an admin: every area, every product
121
+ plaiful studio invites # pending and expired invites (resend <inviteId>: a new link; cancel <inviteId>)
122
+ plaiful studio set sam@example.com --role analyst --area art=edit # change someone; what you leave out stays as it is
123
+ plaiful studio remove sam@example.com # asks first (--yes skips that); the product API keys they issued stop working
124
+ plaiful studio audit --limit 20 # who changed what in the studio, newest first (--before <id> for older)
125
+ plaiful upload ovid-map-biomes-tiles.json ovid-map-kingdoms-tiles.json ovid-map-colors.json # map tiles → map-data/
126
+ plaiful whoami # who you are (or which key), and your products
127
+ plaiful logout
128
+ ```
129
+
130
+ `plaiful help` lists every command and option.
131
+
132
+ ### Notes
133
+
134
+ - `--json` on any command prints the platform's answer as JSON (for agents). Exit codes: `0` done, `1` the platform
135
+ said no (invalid, not allowed, not signed in), `2` the command itself was wrong.
136
+ - Everything works in **dev**. Staging and prod get your content through Plaiful's promotion.
137
+ - `docs pull` keeps `client-config.md` (your keys) out of git with `docs/plaiful/.gitignore`, and prints the
138
+ `git rm --cached` line if it was committed before.
139
+ - `clone` needs access to the repo on GitHub (git signed in: `gh auth login` or Git Credential Manager), and
140
+ `npm install` needs npm access to the `@plaiful` packages. It writes `.env.development` only when the repo has the
141
+ web template's `.env.development.example`.
142
+ - `lists set` writes a StringList in your product's namespace. It won't touch a key (SecureString), a setting (a plain
143
+ String), or `access/*` (who may play).
144
+ - The sign-in is kept in `~/.plaiful/credentials`, never in the repo. `PLAIFUL_API_URL` or `--api` points at another API.
145
+ - You need to be on the Plaiful allowlist, and own or be shared the product (Plaiful staff: every product).
146
+ - `studio` commands act on your studio, not one product: every member can `show` it; only its admins invite, change,
147
+ remove and read the `audit`. They need a sign-in (`plaiful login`), never a product key. In more than one studio,
148
+ name it with `--studio <id or name>`. Roles: `admin`, or a preset (`producer`, `developer`, `narrative-designer`,
149
+ `artist`, `game-designer`, `analyst`, `viewer`); `--area <area>=view|edit|manage|none` adjusts one area;
150
+ `--products a,b` limits a member to some of the studio's products (default: all).
151
+ - Plaiful doesn't email invites yet: `studio invite` and `studio resend` print the link, and you send it. It works
152
+ for 7 days, for the invited email only.
153
+ - From a PlaifulCMS checkout instead of npm: `npm install -g <path to PlaifulCMS>/packages/plaiful-cli`. The package
154
+ is public on npmjs.com; it holds no secrets, and everything it does needs a CMS sign-in or a key.
155
+
156
+ ### Keys for agents and CI
157
+
158
+ A product's owner issues keys in the CMS: Product deployment → the product → **CLI keys**. A key is shown once; set
159
+ it as `PLAIFUL_TOKEN` in CI or the agent's environment (never in the repo) and the CLI uses it instead of a sign-in:
160
+
161
+ ```sh
162
+ PLAIFUL_TOKEN=plf_k_… plaiful seed world --apply
163
+ ```
164
+
165
+ A key acts as the owner who issued it, on that one product, in dev, for the scopes picked (`docs`, `status`, `seed`,
166
+ `ovid:publish`, `lists`, `upload`). Revoking it in the CMS stops it at once; so does its issuer losing the product. The
167
+ same screen shows the product's activity: everything the CLI and its keys did.
168
+
169
+ ### For Plaiful staff
170
+
171
+ - **Design:** `docs/system/product/PARTNER_API_AND_CLI.md`.
172
+ - **Publishing a new version:** bump `version` in `package.json`, then `npm publish` from this folder, signed in to
173
+ npm as a member of the `plaiful` org.
174
+ - **Tests:** the end-to-end tests run this CLI against the partner API handler:
175
+ `lambda/functions/partner-api/__tests__/partner-api.test.js`.
176
+ - **The model registry (`plaiful models`, staff only):** publish release cards with their files, push training data,
177
+ and run GPU training on Google Cloud (`models train`, with your own `gcloud` sign-in). Guide:
178
+ `docs/design/model-registry.md`; card format: `docs/design/model-card.md`. Tests:
179
+ `lambda/functions/partner-api/__tests__/models.test.js` and `models-cli.test.js`.
package/package.json CHANGED
@@ -1,21 +1,21 @@
1
- {
2
- "name": "@plaiful/cli",
3
- "version": "0.15.0",
4
- "description": "The Plaiful CLI: work on your Plaiful product from your game repo, with no AWS access",
5
- "bin": {
6
- "plaiful": "bin/plaiful.js"
7
- },
8
- "files": [
9
- "bin",
10
- "src",
11
- "README.md"
12
- ],
13
- "engines": {
14
- "node": ">=18"
15
- },
16
- "license": "UNLICENSED",
17
- "publishConfig": {
18
- "registry": "https://registry.npmjs.org/",
19
- "access": "public"
20
- }
21
- }
1
+ {
2
+ "name": "@plaiful/cli",
3
+ "version": "0.16.1",
4
+ "description": "The Plaiful CLI: work on your Plaiful product from your game repo, with no AWS access",
5
+ "bin": {
6
+ "plaiful": "bin/plaiful.js"
7
+ },
8
+ "files": [
9
+ "bin",
10
+ "src",
11
+ "README.md"
12
+ ],
13
+ "engines": {
14
+ "node": ">=18"
15
+ },
16
+ "license": "UNLICENSED",
17
+ "publishConfig": {
18
+ "registry": "https://registry.npmjs.org/",
19
+ "access": "public"
20
+ }
21
+ }