Skip to main content
Version: 2.5

Register a workspace

Goal: use the same remote account with a particular checkout. Prerequisite: the dev context from quickstart. Clone your project normally. For a new workspace the shared manifest is minimal:

project: tsm
product: tsm
packages:
  directory: packages

Save this as tsm-project.yaml at the project root. Add /.tsm/ to .gitignore. Set WORKSPACE to its absolute directory (POSIX shell):

export WORKSPACE="$HOME/work/tsm-demo"

Register the checkout (this only changes your home config):

tsm cli config workspace add demo --path "${WORKSPACE}" --project tsm --context dev
tsm --workspace demo context show --explain
tsm cli config workspace list

Expected: demo names the checkout, default context dev; context show explains the origin of each selection. From the checkout root, tsm cli config workspace add can infer name/path/project and offer compatible defaults. Explicit flags as above are deterministic in scripts. The command does not clone or start services. Register a second checkout with another name/path; both may reference the same dev context and account. Relative package/file arguments with --workspace are resolved under that selected workspace.

Cleanup: tsm cli config workspace remove demo unregisters it, retaining checkout and runtime data. Use runtime down before deleting an actual runtime workspace from disk.