@deepraxis/cli 0.2.2-dev.d3030b1 → 0.2.2-dev.d8d3f52

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/COMMANDS.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Generated by `bun run commands`. DO NOT EDIT.
4
4
 
5
- 619 HTTP operations; 621 commands including aliases.
5
+ 633 HTTP operations; 635 commands including aliases.
6
6
 
7
7
  Environment: `PRAXIS_ENV=develop|production` (dev package defaults to `develop`; stable package defaults to `production`). No `--env` option.
8
8
 
@@ -16,7 +16,7 @@ Other lists use global `--limit` only for client-side display truncation, even i
16
16
 
17
17
  Every generated command below is typed after `praxis api` (the `Command` column shows the full path); the word after `api` decides the form: an uppercase HTTP method is a raw request, anything else a generated command path.
18
18
 
19
- Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <organization_id>`, `app create <name> [--dir <path>] [--template <dir>] [--no-install]`, `app publish [--dir <path>] [--no-build]`, `app rollback [--dir <path>] [--to <version_id>]`, `devops deploy plan [--env <name>] [--since <commit>]`, `devops test run --remote [--project <dvp_…>] [--no-wait] [--repeat <n>] [--select <kind:value>]`, `skill [--install <dir>]`, `api <METHOD> <path> [--data …]`.
19
+ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <organization_id>`, `app create <name> [--dir <path>] [--template <dir>] [--no-install]`, `app publish [--dir <path>] [--no-build]`, `app rollback [--dir <path>] [--to <version_id>]`, `devops deploy plan [--env <name>] [--since <commit>]`, `devops test run --remote [--project <dvp_…>] [--no-wait] [--repeat <n>] [--select <kind:value>]`, `canvas import <file.pen> [--name <name>] [--canvas <cvs_…> --yes] [--frames <id,id>] [--image-root <dir>] [--dry-run]`, `skill [--install <dir>]`, `api <METHOD> <path> [--data …]`.
20
20
 
21
21
  | Command | SDK method | HTTP | Parameter options |
22
22
  |---|---|---|---|
@@ -380,14 +380,17 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
380
380
  | `praxis api knowledge vector-store search <vector_store_id>` | `knowledge.vectorStores.search.create` | POST `/knowledge/v1/vector_stores/{vector_store_id}/search` | `--max-num-results`, `--rewrite-query`, `--next-page` |
381
381
  | `praxis api knowledge vector-store segment get <chunk_id>` | `knowledge.vectorStores.segments.retrieve` | GET `/knowledge/v1/vector_stores/{vector_store_id}/segments/{chunk_id}` | `--vector-store` |
382
382
  | `praxis api knowledge vector-store update <vector_store_id>` | `knowledge.vectorStores.update` | POST `/knowledge/v1/vector_stores/{vector_store_id}` | `--name` |
383
+ | `praxis api media asset edit <asset_id>` | `media.assets.edit` | POST `/media/v1/libraries/{library_id}/assets/{asset_id}/edits` | `--library`, `--model`, `--asset-folder`, `--understanding`, `--idempotency-key` |
384
+ | `praxis api media asset lineage <asset_id>` | `media.assets.lineage` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}/lineage` | `--library` |
383
385
  | `praxis api media generation capability list` | `media.generation.capabilities.list` | GET `/media/v1/generation/capabilities` | |
386
+ | `praxis api media image generate` | `media.images.generate` | POST `/media/v1/libraries/{library_id}/images/generations` | `--library`, `--prompt`, `--negative-prompt`, `--n`, `--size`, `--background`, `--output-format`, `--output`, `--seed`, `--model`, `--asset-folder`, `--understanding`, `--idempotency-key` |
384
387
  | `praxis api media library asset batch <library_id>` | `media.libraries.assets.batch` | POST `/media/v1/libraries/{library_id}/assets:batch` | `--reason` |
385
388
  | `praxis api media library asset create` | `media.libraries.assets.create` | POST `/media/v1/libraries/{library_id}/assets` | `--library`, `--file`, `--public-id`, `--public-id-prefix`, `--display-name`, `--asset-folder`, `--use-filename`, `--unique-filename`, `--use-filename-as-display-name`, `--filename-override`, `--overwrite`, `--auto-tagging`, `--resource-type`, `--type` |
386
389
  | `praxis api media library asset delete <asset_id>` | `media.libraries.assets.delete` | DELETE `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
387
390
  | `praxis api media library asset frame create` | `media.libraries.assets.frames.create` | POST `/media/v1/libraries/{library_id}/assets/{asset_id}/frames` | `--library`, `--asset`, `--at-micros`, `--width` |
388
391
  | `praxis api media library asset get <asset_id>` | `media.libraries.assets.retrieve` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
389
392
  | `praxis api media library asset import` | `media.libraries.assets.import.create` | POST `/media/v1/libraries/{library_id}/assets/import` | `--library`, `--file-id`, `--public-id`, `--public-id-prefix`, `--display-name`, `--asset-folder`, `--use-filename`, `--unique-filename`, `--use-filename-as-display-name`, `--filename-override`, `--overwrite`, `--auto-tagging`, `--resource-type`, `--type` |
390
- | `praxis api media library asset list` | `media.libraries.assets.list` | GET `/media/v1/libraries/{library_id}/assets` | `--library`, `--asset-folder`, `--resource-type`, `--param-cursor`, `--param-limit` |
393
+ | `praxis api media library asset list` | `media.libraries.assets.list` | GET `/media/v1/libraries/{library_id}/assets` | `--library`, `--asset-folder`, `--resource-type`, `--material-type`, `--param-cursor`, `--param-limit` |
391
394
  | `praxis api media library asset reprocess <asset_id>` | `media.libraries.assets.reprocess.create` | POST `/media/v1/libraries/{library_id}/assets/{asset_id}/reprocess` | `--library`, `--kinds` |
392
395
  | `praxis api media library asset understanding list` | `media.libraries.assets.understandings.list` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}/understandings` | `--library`, `--asset`, `--include-superseded`, `--kind`, `--param-cursor`, `--param-limit` |
393
396
  | `praxis api media library asset update <asset_id>` | `media.libraries.assets.update` | PATCH `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library`, `--display-name`, `--asset-folder`, `--tags` |
@@ -400,6 +403,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
400
403
  | `praxis api media library folder list` | `media.libraries.folders.list` | GET `/media/v1/libraries/{library_id}/folders` | `--library`, `--parent` |
401
404
  | `praxis api media library generation create` | `media.libraries.generations.create` | POST `/media/v1/libraries/{library_id}/generations` | `--library`, `--intent`, `--prompt`, `--count`, `--duration-seconds`, `--aspect-ratio`, `--model`, `--save`, `--asset-folder`, `--tags`, `--understanding` |
402
405
  | `praxis api media library get <library_id>` | `media.libraries.retrieve` | GET `/media/v1/libraries/{library_id}` | |
406
+ | `praxis api media library get-default` | `media.libraries.retrieveDefault` | GET `/media/v1/libraries/default` | |
403
407
  | `praxis api media library job cancel <job_id>` | `media.libraries.jobs.cancel` | POST `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | `--library` |
404
408
  | `praxis api media library job get <job_id>` | `media.libraries.jobs.retrieve` | GET `/media/v1/libraries/{library_id}/jobs/{job_id}` | `--library` |
405
409
  | `praxis api media library job list` | `media.libraries.jobs.list` | GET `/media/v1/libraries/{library_id}/jobs` | `--library`, `--status`, `--param-limit`, `--param-cursor` |
@@ -407,10 +411,11 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
407
411
  | `praxis api media library list` | `media.libraries.list` | GET `/media/v1/libraries` | `--param-cursor`, `--param-limit`, `--labels`, `--status` |
408
412
  | `praxis api media library purge <library_id>` | `media.libraries.purge.create` | POST `/media/v1/libraries/{library_id}/purge` | |
409
413
  | `praxis api media library restore <library_id>` | `media.libraries.restore` | POST `/media/v1/libraries/{library_id}/restore` | |
410
- | `praxis api media library search <library_id>` | `media.libraries.search.create` | POST `/media/v1/libraries/{library_id}/search` | `--query`, `--filter`, `--top-k`, `--mode` |
414
+ | `praxis api media library search <library_id>` | `media.libraries.search.create` | POST `/media/v1/libraries/{library_id}/search` | `--query`, `--filter`, `--top-k`, `--mode`, `--material-type` |
411
415
  | `praxis api media library search-expression` | `media.libraries.search.expression.create` | POST `/media/v1/libraries/{library_id}/search/expression` | `--library`, `--expression`, `--max-results`, `--next-cursor`, `--with-field`, `--aggregate` |
412
- | `praxis api media library search-semantic` | `media.libraries.search.semantic.create` | POST `/media/v1/libraries/{library_id}/search/semantic` | `--library`, `--query`, `--filter`, `--top-k`, `--mode` |
416
+ | `praxis api media library search-semantic` | `media.libraries.search.semantic.create` | POST `/media/v1/libraries/{library_id}/search/semantic` | `--library`, `--query`, `--filter`, `--top-k`, `--mode`, `--material-type` |
413
417
  | `praxis api media library search-visual` | `media.libraries.search.visual.create` | POST `/media/v1/libraries/{library_id}/search/visual` | `--library`, `--asset-id`, `--top-k`, `--filter` |
418
+ | `praxis api media library set-default` | `media.libraries.setDefault` | PUT `/media/v1/libraries/default` | `--library-id` |
414
419
  | `praxis api media library understanding get-failure-summary` | `media.libraries.understandings.retrieveFailureSummary` | GET `/media/v1/libraries/{library_id}/understandings/failure_summary` | `--library` |
415
420
  | `praxis api media library understanding list` | `media.libraries.understandings.list` | GET `/media/v1/libraries/{library_id}/understandings` | `--library`, `--folder`, `--kinds`, `--param-cursor`, `--param-limit` |
416
421
  | `praxis api media library update <library_id>` | `media.libraries.update` | PATCH `/media/v1/libraries/{library_id}` | `--hotwords`, `--name` |
@@ -457,6 +462,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
457
462
  | `praxis api ontology changeset create` | `ontology.changesets.create` | POST `/ontology/v1/changesets` | `--at`, `--scope` |
458
463
  | `praxis api ontology node create` | `ontology.nodes.create` | POST `/ontology/v1/nodes` | `--type`, `--ref`, `--name`, `--aliases`, `--description`, `--owner` |
459
464
  | `praxis api ontology node get <node_id>` | `ontology.nodes.retrieve` | GET `/ontology/v1/nodes/{node_id}` | `--expand`, `--as-of` |
465
+ | `praxis api ontology node get-neighborhood <node_id>` | `ontology.nodes.retrieveNeighborhood` | GET `/ontology/v1/nodes/{node_id}/neighborhood` | `--depth`, `--param-limit`, `--direction`, `--as-of`, `--include-invalid` |
460
466
  | `praxis api ontology node list` | `ontology.nodes.list` | GET `/ontology/v1/nodes` | `--type`, `--q`, `--owner`, `--as-of`, `--param-limit`, `--param-cursor` |
461
467
  | `praxis api ontology node merge create` | `ontology.nodes.merge.create` | POST `/ontology/v1/nodes/{node_id}/merge` | `--node`, `--into` |
462
468
  | `praxis api ontology node update <node_id>` | `ontology.nodes.update` | PATCH `/ontology/v1/nodes/{node_id}` | `--name`, `--aliases`, `--description` |
@@ -559,6 +565,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
559
565
  | `praxis api studio work draft get-review <draft>` | `studio.works.drafts.retrieveReview` | GET `/studio/v1/works/{work}/drafts/{draft}/review` | `--work`, `--page-token` |
560
566
  | `praxis api studio work draft list` | `studio.works.drafts.list` | GET `/studio/v1/works/{work}/drafts` | `--work` |
561
567
  | `praxis api studio work draft rebase <draft>` | `studio.works.drafts.rebase` | POST `/studio/v1/works/{work}/drafts/{draft}:rebase` | `--work`, `--expected-revision` |
568
+ | `praxis api studio work draft rendition create` | `studio.works.drafts.renditions.create` | POST `/studio/v1/works/{work}/drafts/{draft}/renditions` | `--work`, `--draft`, `--platform`, `--theme`, `--render`, `--request-id` |
562
569
  | `praxis api studio work draft status list` | `studio.works.drafts.status.list` | GET `/studio/v1/works/{work}/drafts/{draft}/status` | `--work`, `--draft` |
563
570
  | `praxis api studio work draft unit batch-create <draft>` | `studio.works.drafts.units.batchCreate` | POST `/studio/v1/works/{work}/drafts/{draft}/units:batchCreate` | `--work`, `--expected-revision`, `--parent` |
564
571
  | `praxis api studio work draft unit batch-update <draft>` | `studio.works.drafts.units.batchUpdate` | POST `/studio/v1/works/{work}/drafts/{draft}/units:batchUpdate` | `--work`, `--expected-revision` |
@@ -566,6 +573,13 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
566
573
  | `praxis api studio work draft update <draft>` | `studio.works.drafts.update` | PATCH `/studio/v1/works/{work}/drafts/{draft}` | `--work`, `--update-mask`, `--expected-revision`, `--title`, `--key`, `--style`, `--mode` |
567
574
  | `praxis api studio work get <work>` | `studio.works.retrieve` | GET `/studio/v1/works/{work}` | `--draft`, `--unit`, `--expand` |
568
575
  | `praxis api studio work list` | `studio.works.list` | GET `/studio/v1/works` | `--page-size`, `--page-token`, `--archived` |
576
+ | `praxis api studio work rendition delete <rendition>` | `studio.works.renditions.delete` | DELETE `/studio/v1/works/{work}/renditions/{rendition}` | `--work` |
577
+ | `praxis api studio work rendition get <rendition>` | `studio.works.renditions.retrieve` | GET `/studio/v1/works/{work}/renditions/{rendition}` | `--work` |
578
+ | `praxis api studio work rendition get-content <rendition>` | `studio.works.renditions.retrieveContent` | GET `/studio/v1/works/{work}/renditions/{rendition}/content` | `--work`, `--part` |
579
+ | `praxis api studio work rendition list` | `studio.works.renditions.list` | GET `/studio/v1/works/{work}/renditions` | `--work`, `--draft`, `--page-size`, `--page-token` |
580
+ | `praxis api studio work rendition publish <rendition>` | `studio.works.renditions.publish` | POST `/studio/v1/works/{work}/renditions/{rendition}:publish` | `--work` |
581
+ | `praxis api studio work rendition render <rendition>` | `studio.works.renditions.render` | POST `/studio/v1/works/{work}/renditions/{rendition}:render` | `--work` |
582
+ | `praxis api studio work rendition update <rendition>` | `studio.works.renditions.update` | PATCH `/studio/v1/works/{work}/renditions/{rendition}` | `--work`, `--update-mask`, `--theme` |
569
583
  | `praxis api studio work resolve` | `studio.works.resolve` | GET `/studio/v1/works:resolve` | `--ref` |
570
584
  | `praxis api studio work unit block patch <unit>` | `studio.works.units.blocks.patch` | POST `/studio/v1/works/{work}/units/{unit}/blocks:patch` | `--work`, `--expected-revision`, `--confirm-final-edit` |
571
585
  | `praxis api studio work unit get <unit>` | `studio.works.units.retrieve` | GET `/studio/v1/works/{work}/units/{unit}` | `--work`, `--view` |
@@ -573,7 +587,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
573
587
  | `praxis api studio work unit move <unit>` | `studio.works.units.move` | POST `/studio/v1/works/{work}/units/{unit}:move` | `--work`, `--expected-revision`, `--parent`, `--after` |
574
588
  | `praxis api studio work unit update <unit>` | `studio.works.units.update` | PATCH `/studio/v1/works/{work}/units/{unit}` | `--work`, `--expected-revision`, `--name`, `--heading`, `--synopsis`, `--points`, `--brief-points`, `--body`, `--synopsis-from-body`, `--status`, `--seconds`, `--confirm-final-edit` |
575
589
  | `praxis api studio work update <work>` | `studio.works.update` | PATCH `/studio/v1/works/{work}` | `--update-mask`, `--expected-revision`, `--title`, `--slug`, `--codexes`, `--style`, `--archived` |
576
- | `praxis api studio work update-brief <work>` | `studio.works.updateBrief` | PATCH `/studio/v1/works/{work}/brief` | `--expected-revision`, `--text`, `--attachments`, `--add-points`, `--remove-points` |
590
+ | `praxis api studio work update-brief <work>` | `studio.works.updateBrief` | PATCH `/studio/v1/works/{work}/brief` | `--expected-revision`, `--text`, `--attachments`, `--remove-points` |
577
591
  | `praxis api ticket activity get` | `ticket.activity.retrieve` | GET `/ticket/v1/activity` | `--repository`, `--page-size`, `--page-token`, `--filter` |
578
592
  | `praxis api ticket comment create` | `ticket.tickets.comments.create` | POST `/ticket/v1/tickets/{number}/comments` | `--ticket`, `--repository`, `--body`, `--in-reply-to` |
579
593
  | `praxis api ticket comment delete <id>` | `ticket.comments.delete` | DELETE `/ticket/v1/comments/{id}` | `--repository` |
package/README.md CHANGED
@@ -38,7 +38,7 @@ praxis app rollback # deploy the previous version again
38
38
 
39
39
  `praxis.jsonc` at the project root names the app and may declare `"secrets": {"SESSION_SECRET": "generate"}`
40
40
  (created once, kept by every later deploy) and `"healthcheck": "/api/health"` (a failing check fails the deploy).
41
- In computers and sandboxes the CLI signs in with `PRAXIS_API_TOKEN`; `PRAXIS_API_KEY` takes precedence when both are set.
41
+ In computers and sandboxes the CLI signs in with `PRAXIS_API_TOKEN`; an API key for the same environment takes precedence when both are set.
42
42
 
43
43
  ## Run the tests of a DevOps project
44
44
 
@@ -100,12 +100,17 @@ praxis api model list --org <organization_id> # just this call
100
100
 
101
101
  For CI and other headless environments, create an API key in the
102
102
  [Console](https://console.deepraxis.com/keys) and set it instead of logging in.
103
- `PRAXIS_API_KEY` always takes precedence over a stored login:
103
+ An API key belongs to one environment, so each environment reads its own variable, and that key
104
+ takes precedence over a stored login for the same environment:
104
105
 
105
106
  ```sh
106
- export PRAXIS_API_KEY=<your-api-key>
107
+ export PRAXIS_API_KEY=<your-api-key> # production
108
+ export PRAXIS_API_KEY_DEVELOP=<your-develop-api-key> # develop (PRAXIS_ENV=develop), Praxis team only
107
109
  ```
108
110
 
111
+ A production key in `PRAXIS_API_KEY` is never sent to develop: with `PRAXIS_ENV=develop` the CLI uses
112
+ `PRAXIS_API_KEY_DEVELOP`, or the develop login when it is unset.
113
+
109
114
  ## A tour
110
115
 
111
116
  ### Models
@@ -217,7 +222,8 @@ read results in its compact agent format.
217
222
 
218
223
  | Variable | Purpose |
219
224
  |---|---|
220
- | `PRAXIS_API_KEY` | Authenticate with an API key instead of `praxis login`. |
225
+ | `PRAXIS_API_KEY` | Authenticate to production with an API key instead of `praxis login`. |
226
+ | `PRAXIS_API_KEY_DEVELOP` | The same for develop (`PRAXIS_ENV=develop`); a production key is never used there. |
221
227
  | `PRAXIS_ENV` | `production` (default) or `develop`, for Praxis team members testing pre-release services. |
222
228
  | `PRAXIS_CREDENTIAL_STORE` | Set to `file` to keep logins out of the system keychain, for example in disposable test homes. |
223
229
  | `NO_COLOR` | Disable colors in human output. |