Soln Studio
This category lists the 27 Runtime system commands under system.studio..
Organize Pages and Scripts by Responsibility
Prefer multiple cohesive files instead of putting an entire feature into one entry. Read the existing asset tree before editing and reuse appropriate modules.
- Pages: keep
src/App.tsxfocused on composition. Put substantial UI sections insrc/client/components/, data/state hooks insrc/client/hooks/, server actions and business services insrc/server/, and browser-safe types or pure helpers insrc/shared/. - Scripts: keep the configured entry focused on orchestration. Separate validation, business rules, external API adapters, and reusable helpers into local modules when those responsibilities grow.
- Use descriptive English file names and relative imports. Keep each file focused; split growing files before roughly 500–600 lines. This is a maintenance guideline, not a compiler limit. Small cohesive features do not need artificial fragmentation.
- Client code must not import server modules. Shared modules must be safe in every runtime that imports them; call declared server actions through
callAction. - Apply related file and import changes together, compile the complete asset with its active binding, inspect all diagnostics, then save and publish separately. A successful file write is not successful compilation or publication.
For built-in antd import rules and Runtime dependency errors, see Soln Studio.
1. List assets
Full name: system.studio.asset.list
List studio asset records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio asset list \
[--keyword value] [--asset-type script|page] \
[--status unpublished|published] [--include-files] [--cursor value] \
[--limit n] [--json]
Parameters: none beyond common options such as --json.
2. Retrieve asset
Full name: system.studio.asset.get
Retrieve studio asset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio asset get --asset-id <uuid> [--json]
Parameters: none beyond common options such as --json.
3. Create asset
Full name: system.studio.asset.create
Create studio asset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio asset create \
(--definition-json json|--definition-file path) [--json]
Parameters: none beyond common options such as --json.
4. Update asset
Full name: system.studio.asset.update
Update studio asset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio asset update \
--asset-id <uuid> (--definition-json json|--definition-file path) \
[--json]
Parameters: none beyond common options such as --json.
5. Delete asset
Full name: system.studio.asset.delete
Delete studio asset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio asset delete --asset-id <uuid> [--json]
Parameters: none beyond common options such as --json.
6. Compile asset
Full name: system.studio.asset.compile
Compile studio asset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio asset compile \
--asset-id <uuid> [--runtime-binding-id binding] \
[--runtime-binding-file path] [--json]
Parameters: none beyond common options such as --json.
7. Publish asset
Full name: system.studio.asset.publish
Publish studio asset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio asset publish \
--asset-id <uuid> [--notes value] [--json]
Parameters: none beyond common options such as --json.
8. Unpublish asset
Full name: system.studio.asset.unpublish
Unpublish studio asset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio asset unpublish --asset-id <uuid> [--json]
Parameters: none beyond common options such as --json.
9. List asset files
Full name: system.studio.asset.file.list
List studio asset file records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio asset file list \
--asset-id <uuid> [--keyword value] [--path-prefix value] \
[--cursor value] [--limit n] [--json]
Parameters: none beyond common options such as --json.
10. List asset file versions
Full name: system.studio.asset.file.version.list
List studio asset file version records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio asset file version list \
--asset-id <uuid> --file-path value [--cursor value] [--limit n] \
[--json]
Parameters: none beyond common options such as --json.
11. Retrieve asset version
Full name: system.studio.asset.version.get
Retrieve studio asset version resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio asset version get \
--asset-id <uuid> (--version-id <uuid>|--version-no n) [--json]
Parameters: none beyond common options such as --json.
12. Open workspace
Full name: system.studio.workspace.open
Open studio workspace resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio workspace open --asset-id <uuid> [--json]
Parameters: none beyond common options such as --json.
13. Read the snapshot for the workspace
Full name: system.studio.workspace.snapshot
Read the snapshot for studio workspace. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio workspace snapshot \
--asset-id <uuid> --session-id <uuid> [--json]
Parameters: none beyond common options such as --json.
14. Read workspace file
Full name: system.studio.workspace.file.read
Read studio workspace file resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio workspace file read \
--asset-id <uuid> --session-id <uuid> --file-path value [--json]
Parameters: none beyond common options such as --json.
15. Search workspace file
Full name: system.studio.workspace.file.search
Search studio workspace file records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio workspace file search \
--asset-id <uuid> --session-id <uuid> --query value [--case-sensitive] \
[--limit n] [--json]
Parameters: none beyond common options such as --json.
16. Move workspace file
Full name: system.studio.workspace.file.move
Move studio workspace file resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio workspace file move \
--asset-id <uuid> --session-id <uuid> --base-revision n \
--from-path value --to-path value --expected-content-file path \
[--no-compile] [--json]
Parameters: none beyond common options such as --json.
17. Apply a patch to the workspace
Full name: system.studio.workspace.patch
Apply a patch to studio workspace. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio workspace patch \
--asset-id <uuid> --session-id <uuid> --base-revision n \
--patch-file path [--no-compile] [--json]
Parameters: none beyond common options such as --json.
18. Apply workspace recipe
Full name: system.studio.workspace.recipe.apply
Apply studio workspace recipe resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio workspace recipe apply \
--session-id <uuid> --base-revision n \
(--definition-json json|--definition-file path) [--no-compile] \
[--json]
Parameters: none beyond common options such as --json.
19. Compile workspace
Full name: system.studio.workspace.compile
Compile studio workspace resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio workspace compile \
--asset-id <uuid> --session-id <uuid> [--runtime-binding-id binding] \
[--runtime-binding-file path] [--json]
Parameters: none beyond common options such as --json.
20. Save workspace
Full name: system.studio.workspace.save
Save studio workspace resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio workspace save \
--asset-id <uuid> --session-id <uuid> [--json]
Parameters: none beyond common options such as --json.
21. Discard workspace
Full name: system.studio.workspace.discard
Discard studio workspace resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio workspace discard \
--asset-id <uuid> --session-id <uuid> [--json]
Parameters: none beyond common options such as --json.
22. Execute workspace
Full name: system.studio.workspace.execute
Execute studio workspace resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio workspace execute \
--asset-id <uuid> --session-id <uuid> --base-revision n \
[--entry value] [--action-name value] [--payload-json json] [--json]
Parameters: none beyond common options such as --json.
23. Execute asset
Full name: system.studio.asset.execute
Execute studio asset resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio asset execute \
--asset-id <uuid> [--entry value] [--payload-json json] [--json]
Parameters: none beyond common options such as --json.
24. Preview page
Full name: system.studio.page.preview
Preview studio page resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio page preview --asset-id <uuid> [--entry value] [--json]
Parameters: none beyond common options such as --json.
25. Execute page action
Full name: system.studio.page.action.execute
Execute studio page action resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write
sl system studio page action execute \
--asset-id <uuid> --action-name value [--workspace-app-code value] \
[--payload-json json] [--json]
Parameters: none beyond common options such as --json.
26. List executions
Full name: system.studio.execution.list
List studio execution records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio execution list \
[--asset-id <uuid>] [--file-path value] \
[--status running|succeeded|failed] [--keyword value] [--cursor value] \
[--limit n] [--json]
Parameters: none beyond common options such as --json.
27. Retrieve execution
Full name: system.studio.execution.get
Retrieve studio execution resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read
sl system studio execution get --log-id <uuid> [--json]
Parameters: none beyond common options such as --json.