@deepraxis/cli 0.2.2-dev.3987a02 → 0.2.2-dev.4034191
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 +103 -5
- package/README.md +11 -5
- package/dist/praxis.js +29034 -14368
- package/package.json +1 -1
package/COMMANDS.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Generated by `bun run commands`. DO NOT EDIT.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
665 HTTP operations; 667 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
|
|
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
|
|---|---|---|---|
|
|
@@ -219,6 +219,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
219
219
|
| `praxis api browser context update <contextId>` | `browser.contexts.update` | PUT `/browser/v1/contexts/{contextId}` | |
|
|
220
220
|
| `praxis api browser live get <pageId>` | `browser.live.retrieve` | GET `/browser/v1/live/{sessionId}/{pageId}` | `--live`, `--t` |
|
|
221
221
|
| `praxis api browser selenium-unsupported get` | `browser.seleniumUnsupported.retrieve` | GET `/browser/v1/selenium-unsupported` | |
|
|
222
|
+
| `praxis api browser session action create` | `browser.sessions.actions.create` | POST `/browser/v1/sessions/{sessionId}/actions` | `--session` |
|
|
222
223
|
| `praxis api browser session create` | `browser.sessions.create` | POST `/browser/v1/sessions` | `--project-id`, `--keep-alive`, `--timeout`, `--region`, `--extension-id`, `--name` |
|
|
223
224
|
| `praxis api browser session event list` | `browser.sessions.events.list` | GET `/browser/v1/sessions/{sessionId}/events` | `--session`, `--param-cursor`, `--param-limit`, `--types` |
|
|
224
225
|
| `praxis api browser session get <sessionId>` | `browser.sessions.retrieve` | GET `/browser/v1/sessions/{sessionId}` | `--expand` |
|
|
@@ -325,7 +326,28 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
325
326
|
| `praxis api database table list` | `database.databases.tables.list` | GET `/database/v1/databases/{database_id}/tables` | `--database` |
|
|
326
327
|
| `praxis api database table update <table>` | `database.databases.tables.update` | PATCH `/database/v1/databases/{database_id}/tables/{table}` | `--database`, `--name`, `--description` |
|
|
327
328
|
| `praxis api database update <database_id>` | `database.databases.update` | PATCH `/database/v1/databases/{database_id}` | `--name` |
|
|
329
|
+
| `praxis api devops environment checkpoint list` | `devops.environments.checkpoints.list` | GET `/devops/v1/environments/{id}/checkpoints` | `--environment` |
|
|
330
|
+
| `praxis api devops flag archive <id>` | `devops.flags.archive` | POST `/devops/v1/flags/{id}:archive` | |
|
|
331
|
+
| `praxis api devops flag conclude <id>` | `devops.flags.conclude` | POST `/devops/v1/flags/{id}:conclude` | `--action`, `--observe-until`, `--reason` |
|
|
332
|
+
| `praxis api devops flag environment update <environment>` | `devops.flags.environments.update` | PATCH `/devops/v1/flags/{id}/environments/{environment}` | `--flag`, `--param-version`, `--comment` |
|
|
333
|
+
| `praxis api devops flag get <id>` | `devops.flags.retrieve` | GET `/devops/v1/flags/{id}` | |
|
|
334
|
+
| `praxis api devops flag update <id>` | `devops.flags.update` | PATCH `/devops/v1/flags/{id}` | `--update-mask` |
|
|
335
|
+
| `praxis api devops progressive-rollout create` | `devops.progressiveRollouts.create` | POST `/devops/v1/progressive-rollouts` | `--flag`, `--environment`, `--variation`, `--bucket-by` |
|
|
336
|
+
| `praxis api devops progressive-rollout get <id>` | `devops.progressiveRollouts.retrieve` | GET `/devops/v1/progressive-rollouts/{id}` | |
|
|
337
|
+
| `praxis api devops progressive-rollout pause <id>` | `devops.progressiveRollouts.pause` | POST `/devops/v1/progressive-rollouts/{id}:pause` | `--reason` |
|
|
338
|
+
| `praxis api devops progressive-rollout resume <id>` | `devops.progressiveRollouts.resume` | POST `/devops/v1/progressive-rollouts/{id}:resume` | |
|
|
339
|
+
| `praxis api devops progressive-rollout rollback <id>` | `devops.progressiveRollouts.rollback` | POST `/devops/v1/progressive-rollouts/{id}:rollback` | `--reason` |
|
|
340
|
+
| `praxis api devops project environment list` | `devops.projects.environments.list` | GET `/devops/v1/projects/{project}/environments` | `--project` |
|
|
341
|
+
| `praxis api devops project flag create` | `devops.projects.flags.create` | POST `/devops/v1/projects/{project}/flags` | `--project`, `--key`, `--name`, `--description`, `--kind`, `--value-type`, `--observe-until`, `--removal-ticket`, `--pull-request`, `--request-id` |
|
|
342
|
+
| `praxis api devops project flag list` | `devops.projects.flags.list` | GET `/devops/v1/projects/{project}/flags` | `--project`, `--page-size`, `--page-token`, `--filter` |
|
|
343
|
+
| `praxis api devops project get <id>` | `devops.projects.retrieve` | GET `/devops/v1/projects/{id}` | |
|
|
328
344
|
| `praxis api devops project get-test-catalog <project>` | `devops.projects.retrieveTestCatalog` | GET `/devops/v1/projects/{project}/test-catalog` | `--commit` |
|
|
345
|
+
| `praxis api devops project list` | `devops.projects.list` | GET `/devops/v1/projects` | `--page-size`, `--page-token` |
|
|
346
|
+
| `praxis api devops project promotion list` | `devops.projects.promotions.list` | GET `/devops/v1/projects/{project}/promotions` | `--project`, `--page-size`, `--page-token` |
|
|
347
|
+
| `praxis api devops project release create` | `devops.projects.releases.create` | POST `/devops/v1/projects/{project}/releases` | `--project`, `--commit`, `--base`, `--picks`, `--validate-only`, `--request-id` |
|
|
348
|
+
| `praxis api devops project release list` | `devops.projects.releases.list` | GET `/devops/v1/projects/{project}/releases` | `--project`, `--page-size`, `--page-token` |
|
|
349
|
+
| `praxis api devops project target list` | `devops.projects.targets.list` | GET `/devops/v1/projects/{project}/targets` | `--project`, `--page-size`, `--page-token` |
|
|
350
|
+
| `praxis api devops project target refresh <project>` | `devops.projects.targets.refresh` | POST `/devops/v1/projects/{project}/targets:refresh` | `--commit` |
|
|
329
351
|
| `praxis api devops project test-case list` | `devops.projects.testCases.list` | GET `/devops/v1/projects/{project}/test-cases` | `--project`, `--page-size`, `--page-token`, `--filter`, `--order-by` |
|
|
330
352
|
| `praxis api devops project test-plan create` | `devops.projects.testPlans.create` | POST `/devops/v1/projects/{project}/test-plans` | `--project`, `--key`, `--title`, `--stage`, `--environment`, `--gate`, `--repeat`, `--timeout-minutes` |
|
|
331
353
|
| `praxis api devops project test-plan list` | `devops.projects.testPlans.list` | GET `/devops/v1/projects/{project}/test-plans` | `--project`, `--page-size`, `--page-token`, `--order-by` |
|
|
@@ -333,6 +355,16 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
333
355
|
| `praxis api devops project test-run create` | `devops.projects.testRuns.create` | POST `/devops/v1/projects/{project}/test-runs` | `--project`, `--plan`, `--environment`, `--repeat`, `--wait-until`, `--executor`, `--request-id` |
|
|
334
356
|
| `praxis api devops project test-run list` | `devops.projects.testRuns.list` | GET `/devops/v1/projects/{project}/test-runs` | `--project`, `--page-size`, `--page-token`, `--filter`, `--order-by` |
|
|
335
357
|
| `praxis api devops project test-suite list` | `devops.projects.testSuites.list` | GET `/devops/v1/projects/{project}/test-suites` | `--project`, `--page-size`, `--page-token`, `--order-by` |
|
|
358
|
+
| `praxis api devops promotion approve <id>` | `devops.promotions.approve` | POST `/devops/v1/promotions/{id}:approve` | `--approved`, `--comment` |
|
|
359
|
+
| `praxis api devops promotion cancel <id>` | `devops.promotions.cancel` | POST `/devops/v1/promotions/{id}:cancel` | `--reason` |
|
|
360
|
+
| `praxis api devops promotion conclude <id>` | `devops.promotions.conclude` | POST `/devops/v1/promotions/{id}:conclude` | `--action`, `--reason` |
|
|
361
|
+
| `praxis api devops promotion create` | `devops.promotions.create` | POST `/devops/v1/promotions` | `--release`, `--environment`, `--path`, `--targets`, `--validate-only`, `--request-id` |
|
|
362
|
+
| `praxis api devops promotion get <id>` | `devops.promotions.retrieve` | GET `/devops/v1/promotions/{id}` | `--expand` |
|
|
363
|
+
| `praxis api devops promotion retry <id>` | `devops.promotions.retry` | POST `/devops/v1/promotions/{id}:retry` | |
|
|
364
|
+
| `praxis api devops promotion rollout list` | `devops.promotions.rollouts.list` | GET `/devops/v1/promotions/{promotion}/rollouts` | `--promotion`, `--page-size`, `--page-token` |
|
|
365
|
+
| `praxis api devops release abandon <id>` | `devops.releases.abandon` | POST `/devops/v1/releases/{id}:abandon` | `--reason` |
|
|
366
|
+
| `praxis api devops release get <id>` | `devops.releases.retrieve` | GET `/devops/v1/releases/{id}` | |
|
|
367
|
+
| `praxis api devops rollout get <id>` | `devops.rollouts.retrieve` | GET `/devops/v1/rollouts/{id}` | |
|
|
336
368
|
| `praxis api devops test-case get <id>` | `devops.testCases.retrieve` | GET `/devops/v1/test-cases/{id}` | |
|
|
337
369
|
| `praxis api devops test-plan delete <id>` | `devops.testPlans.delete` | DELETE `/devops/v1/test-plans/{id}` | |
|
|
338
370
|
| `praxis api devops test-plan get <id>` | `devops.testPlans.retrieve` | GET `/devops/v1/test-plans/{id}` | |
|
|
@@ -379,14 +411,17 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
379
411
|
| `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` |
|
|
380
412
|
| `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` |
|
|
381
413
|
| `praxis api knowledge vector-store update <vector_store_id>` | `knowledge.vectorStores.update` | POST `/knowledge/v1/vector_stores/{vector_store_id}` | `--name` |
|
|
414
|
+
| `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` |
|
|
415
|
+
| `praxis api media asset lineage <asset_id>` | `media.assets.lineage` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}/lineage` | `--library` |
|
|
382
416
|
| `praxis api media generation capability list` | `media.generation.capabilities.list` | GET `/media/v1/generation/capabilities` | |
|
|
417
|
+
| `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` |
|
|
383
418
|
| `praxis api media library asset batch <library_id>` | `media.libraries.assets.batch` | POST `/media/v1/libraries/{library_id}/assets:batch` | `--reason` |
|
|
384
419
|
| `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` |
|
|
385
420
|
| `praxis api media library asset delete <asset_id>` | `media.libraries.assets.delete` | DELETE `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
|
|
386
421
|
| `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` |
|
|
387
422
|
| `praxis api media library asset get <asset_id>` | `media.libraries.assets.retrieve` | GET `/media/v1/libraries/{library_id}/assets/{asset_id}` | `--library` |
|
|
388
423
|
| `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` |
|
|
389
|
-
| `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` |
|
|
424
|
+
| `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` |
|
|
390
425
|
| `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` |
|
|
391
426
|
| `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` |
|
|
392
427
|
| `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` |
|
|
@@ -399,6 +434,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
399
434
|
| `praxis api media library folder list` | `media.libraries.folders.list` | GET `/media/v1/libraries/{library_id}/folders` | `--library`, `--parent` |
|
|
400
435
|
| `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` |
|
|
401
436
|
| `praxis api media library get <library_id>` | `media.libraries.retrieve` | GET `/media/v1/libraries/{library_id}` | |
|
|
437
|
+
| `praxis api media library get-default` | `media.libraries.retrieveDefault` | GET `/media/v1/libraries/default` | |
|
|
402
438
|
| `praxis api media library job cancel <job_id>` | `media.libraries.jobs.cancel` | POST `/media/v1/libraries/{library_id}/jobs/{job_id}/cancel` | `--library` |
|
|
403
439
|
| `praxis api media library job get <job_id>` | `media.libraries.jobs.retrieve` | GET `/media/v1/libraries/{library_id}/jobs/{job_id}` | `--library` |
|
|
404
440
|
| `praxis api media library job list` | `media.libraries.jobs.list` | GET `/media/v1/libraries/{library_id}/jobs` | `--library`, `--status`, `--param-limit`, `--param-cursor` |
|
|
@@ -406,13 +442,15 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
406
442
|
| `praxis api media library list` | `media.libraries.list` | GET `/media/v1/libraries` | `--param-cursor`, `--param-limit`, `--labels`, `--status` |
|
|
407
443
|
| `praxis api media library purge <library_id>` | `media.libraries.purge.create` | POST `/media/v1/libraries/{library_id}/purge` | |
|
|
408
444
|
| `praxis api media library restore <library_id>` | `media.libraries.restore` | POST `/media/v1/libraries/{library_id}/restore` | |
|
|
409
|
-
| `praxis api media library search <library_id>` | `media.libraries.search.create` | POST `/media/v1/libraries/{library_id}/search` | `--query`, `--filter`, `--top-k`, `--mode` |
|
|
445
|
+
| `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` |
|
|
410
446
|
| `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` |
|
|
411
|
-
| `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` |
|
|
447
|
+
| `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` |
|
|
412
448
|
| `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` |
|
|
449
|
+
| `praxis api media library set-default` | `media.libraries.setDefault` | PUT `/media/v1/libraries/default` | `--library-id` |
|
|
413
450
|
| `praxis api media library understanding get-failure-summary` | `media.libraries.understandings.retrieveFailureSummary` | GET `/media/v1/libraries/{library_id}/understandings/failure_summary` | `--library` |
|
|
414
451
|
| `praxis api media library understanding list` | `media.libraries.understandings.list` | GET `/media/v1/libraries/{library_id}/understandings` | `--library`, `--folder`, `--kinds`, `--param-cursor`, `--param-limit` |
|
|
415
452
|
| `praxis api media library update <library_id>` | `media.libraries.update` | PATCH `/media/v1/libraries/{library_id}` | `--hotwords`, `--name` |
|
|
453
|
+
| `praxis api media video generate` | `media.videos.generate` | POST `/media/v1/libraries/{library_id}/videos/generations` | `--library`, `--prompt`, `--negative-prompt`, `--mode`, `--first-frame`, `--last-frame`, `--duration-seconds`, `--resolution`, `--aspect-ratio`, `--generate-audio`, `--output`, `--n`, `--seed`, `--model`, `--asset-folder`, `--understanding`, `--idempotency-key` |
|
|
416
454
|
| `praxis api meta doc get <path>` | `meta.docs.retrieve` | GET `/meta/v1/docs/{path}` | `--lang` |
|
|
417
455
|
| `praxis api meta doc search` | `meta.docs.search` | GET `/meta/v1/docs/search` | `--q`, `--param-limit`, `--lang` |
|
|
418
456
|
| `praxis api meta health get` | `meta.health.retrieve` | GET `/meta/v1/health` | |
|
|
@@ -456,6 +494,7 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
456
494
|
| `praxis api ontology changeset create` | `ontology.changesets.create` | POST `/ontology/v1/changesets` | `--at`, `--scope` |
|
|
457
495
|
| `praxis api ontology node create` | `ontology.nodes.create` | POST `/ontology/v1/nodes` | `--type`, `--ref`, `--name`, `--aliases`, `--description`, `--owner` |
|
|
458
496
|
| `praxis api ontology node get <node_id>` | `ontology.nodes.retrieve` | GET `/ontology/v1/nodes/{node_id}` | `--expand`, `--as-of` |
|
|
497
|
+
| `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` |
|
|
459
498
|
| `praxis api ontology node list` | `ontology.nodes.list` | GET `/ontology/v1/nodes` | `--type`, `--q`, `--owner`, `--as-of`, `--param-limit`, `--param-cursor` |
|
|
460
499
|
| `praxis api ontology node merge create` | `ontology.nodes.merge.create` | POST `/ontology/v1/nodes/{node_id}/merge` | `--node`, `--into` |
|
|
461
500
|
| `praxis api ontology node update <node_id>` | `ontology.nodes.update` | PATCH `/ontology/v1/nodes/{node_id}` | `--name`, `--aliases`, `--description` |
|
|
@@ -522,6 +561,65 @@ Handwritten commands: `login`, `logout`, `whoami`, `org list`, `org switch <orga
|
|
|
522
561
|
| `praxis api search create` | `search.search.create` | POST `/search/v1/search` | `--query`, `--search-depth`, `--chunks-per-source`, `--max-results`, `--topic`, `--time-range`, `--start-date`, `--end-date`, `--include-published-date`, `--filter-by-published-date`, `--include-images`, `--include-image-descriptions`, `--include-favicon`, `--include-domains`, `--exclude-domains`, `--include-domains-mode`, `--country`, `--language`, `--filter-by-language`, `--auto-parameters`, `--exact-match`, `--include-usage`, `--safe-search` |
|
|
523
562
|
| `praxis api search extract` | `search.extract.create` | POST `/search/v1/extract` | `--query`, `--chunks-per-source`, `--extract-depth`, `--include-images`, `--include-favicon`, `--param-format`, `--timeout`, `--include-usage` |
|
|
524
563
|
| `praxis api search map` | `search.map.create` | POST `/search/v1/map` | `--url`, `--instructions`, `--max-depth`, `--max-breadth`, `--param-limit`, `--select-paths`, `--select-domains`, `--exclude-paths`, `--exclude-domains`, `--allow-external`, `--timeout`, `--include-usage` |
|
|
564
|
+
| `praxis api studio codex create` | `studio.codexes.create` | POST `/studio/v1/codexes` | `--name`, `--description` |
|
|
565
|
+
| `praxis api studio codex delete <codex>` | `studio.codexes.delete` | DELETE `/studio/v1/codexes/{codex}` | |
|
|
566
|
+
| `praxis api studio codex entry create` | `studio.codexes.entries.create` | POST `/studio/v1/codexes/{codex}/entries` | `--codex`, `--type`, `--name`, `--aliases`, `--case-sensitive`, `--exclude-phrases`, `--description`, `--notes`, `--tracking`, `--images` |
|
|
567
|
+
| `praxis api studio codex entry delete <entry>` | `studio.codexes.entries.delete` | DELETE `/studio/v1/codexes/{codex}/entries/{entry}` | `--codex` |
|
|
568
|
+
| `praxis api studio codex entry get <entry>` | `studio.codexes.entries.retrieve` | GET `/studio/v1/codexes/{codex}/entries/{entry}` | `--codex` |
|
|
569
|
+
| `praxis api studio codex entry list` | `studio.codexes.entries.list` | GET `/studio/v1/codexes/{codex}/entries` | `--codex`, `--page-size`, `--page-token` |
|
|
570
|
+
| `praxis api studio codex entry update <entry>` | `studio.codexes.entries.update` | PATCH `/studio/v1/codexes/{codex}/entries/{entry}` | `--codex`, `--update-mask`, `--type`, `--name`, `--aliases`, `--case-sensitive`, `--exclude-phrases`, `--description`, `--notes`, `--tracking`, `--images` |
|
|
571
|
+
| `praxis api studio codex get <codex>` | `studio.codexes.retrieve` | GET `/studio/v1/codexes/{codex}` | |
|
|
572
|
+
| `praxis api studio codex list` | `studio.codexes.list` | GET `/studio/v1/codexes` | `--page-size`, `--page-token` |
|
|
573
|
+
| `praxis api studio codex update <codex>` | `studio.codexes.update` | PATCH `/studio/v1/codexes/{codex}` | `--update-mask`, `--name`, `--description` |
|
|
574
|
+
| `praxis api studio genre get <genre>` | `studio.genres.retrieve` | GET `/studio/v1/genres/{genre}` | |
|
|
575
|
+
| `praxis api studio genre list` | `studio.genres.list` | GET `/studio/v1/genres` | `--include-unavailable` |
|
|
576
|
+
| `praxis api studio platform get <platform>` | `studio.platforms.retrieve` | GET `/studio/v1/platforms/{platform}` | |
|
|
577
|
+
| `praxis api studio platform list` | `studio.platforms.list` | GET `/studio/v1/platforms` | `--genre` |
|
|
578
|
+
| `praxis api studio style create` | `studio.styles.create` | POST `/studio/v1/styles` | `--name`, `--description`, `--samples`, `--use`, `--avoid` |
|
|
579
|
+
| `praxis api studio style delete <style>` | `studio.styles.delete` | DELETE `/studio/v1/styles/{style}` | |
|
|
580
|
+
| `praxis api studio style get <style>` | `studio.styles.retrieve` | GET `/studio/v1/styles/{style}` | |
|
|
581
|
+
| `praxis api studio style list` | `studio.styles.list` | GET `/studio/v1/styles` | `--page-size`, `--page-token` |
|
|
582
|
+
| `praxis api studio style update <style>` | `studio.styles.update` | PATCH `/studio/v1/styles/{style}` | `--update-mask`, `--name`, `--description`, `--samples`, `--use`, `--avoid` |
|
|
583
|
+
| `praxis api studio template create` | `studio.templates.create` | POST `/studio/v1/templates` | `--genre`, `--name`, `--guide` |
|
|
584
|
+
| `praxis api studio template delete <template>` | `studio.templates.delete` | DELETE `/studio/v1/templates/{template}` | |
|
|
585
|
+
| `praxis api studio template get <template>` | `studio.templates.retrieve` | GET `/studio/v1/templates/{template}` | |
|
|
586
|
+
| `praxis api studio template list` | `studio.templates.list` | GET `/studio/v1/templates` | `--genre`, `--page-size`, `--page-token` |
|
|
587
|
+
| `praxis api studio theme create` | `studio.themes.create` | POST `/studio/v1/themes` | `--platform`, `--name`, `--html`, `--css`, `--reference-docx`, `--header`, `--footer` |
|
|
588
|
+
| `praxis api studio theme delete <theme>` | `studio.themes.delete` | DELETE `/studio/v1/themes/{theme}` | |
|
|
589
|
+
| `praxis api studio theme get <theme>` | `studio.themes.retrieve` | GET `/studio/v1/themes/{theme}` | |
|
|
590
|
+
| `praxis api studio theme list` | `studio.themes.list` | GET `/studio/v1/themes` | `--platform`, `--page-size`, `--page-token` |
|
|
591
|
+
| `praxis api studio theme update <theme>` | `studio.themes.update` | PATCH `/studio/v1/themes/{theme}` | `--update-mask`, `--name`, `--html`, `--css`, `--reference-docx`, `--header`, `--footer` |
|
|
592
|
+
| `praxis api studio work create` | `studio.works.create` | POST `/studio/v1/works` | `--title`, `--slug`, `--codexes`, `--style`, `--request-id` |
|
|
593
|
+
| `praxis api studio work draft create` | `studio.works.drafts.create` | POST `/studio/v1/works/{work}/drafts` | `--work`, `--genre`, `--title`, `--mode`, `--template`, `--request-id` |
|
|
594
|
+
| `praxis api studio work draft get <draft>` | `studio.works.drafts.retrieve` | GET `/studio/v1/works/{work}/drafts/{draft}` | `--work`, `--expand` |
|
|
595
|
+
| `praxis api studio work draft get-export <draft>` | `studio.works.drafts.retrieveExport` | GET `/studio/v1/works/{work}/drafts/{draft}/export` | `--work`, `--param-format` |
|
|
596
|
+
| `praxis api studio work draft get-outline <draft>` | `studio.works.drafts.retrieveOutline` | GET `/studio/v1/works/{work}/drafts/{draft}/outline` | `--work` |
|
|
597
|
+
| `praxis api studio work draft get-review <draft>` | `studio.works.drafts.retrieveReview` | GET `/studio/v1/works/{work}/drafts/{draft}/review` | `--work`, `--page-token` |
|
|
598
|
+
| `praxis api studio work draft list` | `studio.works.drafts.list` | GET `/studio/v1/works/{work}/drafts` | `--work` |
|
|
599
|
+
| `praxis api studio work draft rebase <draft>` | `studio.works.drafts.rebase` | POST `/studio/v1/works/{work}/drafts/{draft}:rebase` | `--work`, `--expected-revision` |
|
|
600
|
+
| `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` |
|
|
601
|
+
| `praxis api studio work draft status list` | `studio.works.drafts.status.list` | GET `/studio/v1/works/{work}/drafts/{draft}/status` | `--work`, `--draft` |
|
|
602
|
+
| `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` |
|
|
603
|
+
| `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` |
|
|
604
|
+
| `praxis api studio work draft unit create` | `studio.works.drafts.units.create` | POST `/studio/v1/works/{work}/drafts/{draft}/units` | `--work`, `--draft`, `--kind`, `--name`, `--heading`, `--parent`, `--after`, `--synopsis`, `--points`, `--brief-points` |
|
|
605
|
+
| `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` |
|
|
606
|
+
| `praxis api studio work get <work>` | `studio.works.retrieve` | GET `/studio/v1/works/{work}` | `--draft`, `--unit`, `--expand` |
|
|
607
|
+
| `praxis api studio work list` | `studio.works.list` | GET `/studio/v1/works` | `--page-size`, `--page-token`, `--archived` |
|
|
608
|
+
| `praxis api studio work rendition delete <rendition>` | `studio.works.renditions.delete` | DELETE `/studio/v1/works/{work}/renditions/{rendition}` | `--work` |
|
|
609
|
+
| `praxis api studio work rendition get <rendition>` | `studio.works.renditions.retrieve` | GET `/studio/v1/works/{work}/renditions/{rendition}` | `--work` |
|
|
610
|
+
| `praxis api studio work rendition get-content <rendition>` | `studio.works.renditions.retrieveContent` | GET `/studio/v1/works/{work}/renditions/{rendition}/content` | `--work`, `--part` |
|
|
611
|
+
| `praxis api studio work rendition list` | `studio.works.renditions.list` | GET `/studio/v1/works/{work}/renditions` | `--work`, `--draft`, `--page-size`, `--page-token` |
|
|
612
|
+
| `praxis api studio work rendition publish <rendition>` | `studio.works.renditions.publish` | POST `/studio/v1/works/{work}/renditions/{rendition}:publish` | `--work` |
|
|
613
|
+
| `praxis api studio work rendition render <rendition>` | `studio.works.renditions.render` | POST `/studio/v1/works/{work}/renditions/{rendition}:render` | `--work` |
|
|
614
|
+
| `praxis api studio work rendition update <rendition>` | `studio.works.renditions.update` | PATCH `/studio/v1/works/{work}/renditions/{rendition}` | `--work`, `--update-mask`, `--theme` |
|
|
615
|
+
| `praxis api studio work resolve` | `studio.works.resolve` | GET `/studio/v1/works:resolve` | `--ref` |
|
|
616
|
+
| `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` |
|
|
617
|
+
| `praxis api studio work unit get <unit>` | `studio.works.units.retrieve` | GET `/studio/v1/works/{work}/units/{unit}` | `--work`, `--view` |
|
|
618
|
+
| `praxis api studio work unit get-context <unit>` | `studio.works.units.retrieveContext` | GET `/studio/v1/works/{work}/units/{unit}/context` | `--work`, `--budget-tokens` |
|
|
619
|
+
| `praxis api studio work unit move <unit>` | `studio.works.units.move` | POST `/studio/v1/works/{work}/units/{unit}:move` | `--work`, `--expected-revision`, `--parent`, `--after` |
|
|
620
|
+
| `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` |
|
|
621
|
+
| `praxis api studio work update <work>` | `studio.works.update` | PATCH `/studio/v1/works/{work}` | `--update-mask`, `--expected-revision`, `--title`, `--slug`, `--codexes`, `--style`, `--archived` |
|
|
622
|
+
| `praxis api studio work update-brief <work>` | `studio.works.updateBrief` | PATCH `/studio/v1/works/{work}/brief` | `--expected-revision`, `--text`, `--attachments`, `--remove-points` |
|
|
525
623
|
| `praxis api ticket activity get` | `ticket.activity.retrieve` | GET `/ticket/v1/activity` | `--repository`, `--page-size`, `--page-token`, `--filter` |
|
|
526
624
|
| `praxis api ticket comment create` | `ticket.tickets.comments.create` | POST `/ticket/v1/tickets/{number}/comments` | `--ticket`, `--repository`, `--body`, `--in-reply-to` |
|
|
527
625
|
| `praxis api ticket comment delete <id>` | `ticket.comments.delete` | DELETE `/ticket/v1/comments/{id}` | `--repository` |
|
package/README.md
CHANGED
|
@@ -32,13 +32,13 @@ the SDK, so a new API capability reaches the CLI on the day it ships.
|
|
|
32
32
|
|
|
33
33
|
```sh
|
|
34
34
|
praxis app create my-app # standard template, dependencies installed
|
|
35
|
-
cd my-app && praxis app
|
|
35
|
+
cd my-app && praxis app publish # build, publish, create declared secrets, health check, print the URL
|
|
36
36
|
praxis app rollback # deploy the previous version again
|
|
37
37
|
```
|
|
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`;
|
|
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
|
-
|
|
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. |
|