Skip to main content

Workspace Scripts

Workspace scripts keep helper scripts, initialization files, and team runbooks separate from project code. Runtime containers mount them at /scripts.

Startup Entrypoints

ScenarioRecommended entrypoint
Start the local stackpython scripts/dev/docker/ops.py up
Rebuild and start the stackpython scripts/dev/docker/ops.py up --build
Stop the stackpython scripts/dev/docker/ops.py down
Clean workspace resourcespython scripts/dev/docker/ops.py cleanup-workspaces
Full cleanuppython scripts/dev/docker/ops.py cleanup

ops.py is the primary cross-platform host-side CLI for all startup, shutdown, and cleanup workflows.

Runtime Startup Script

The default runtime service starts with:

command: /workspace-runtime/start_services.sh

Workspace-specific initialization scripts are generated or installed by Manager, stored in the data directory, and mounted into runtime when needed.

Mounted Paths

Host pathRuntime pathDescription
./data/workspace-scripts/default-workspace/scriptsDefault workspace scripts
./data/init-scripts/<workspaceId>runtime initialization sourceWorkspace startup scripts
./workspace-runtime/scripts/workspace-runtime/scriptsRuntime service scripts

Supported File Types

Workspace scripts are file collections. Common files include:

ExtensionUsage
.shLinux/macOS shell scripts, best for runtime execution
.ps1PowerShell scripts for Windows host workflows or cross-platform instructions
.mdRunbooks and instructions
.json / .yamlConfiguration or sample payloads

Runtime containers are Linux-based, so scripts intended to run inside runtime should prefer .sh. PowerShell scripts are useful for Windows host-side operations or cross-platform instructions.

See Runtime API for endpoint details.