Skip to main content

CLI reference

Authentication​

npx twl-tool auth login --url APP_URL
npx twl-tool auth status --url APP_URL
npx twl-tool auth logout --url APP_URL

Credential lookup order is --token, TWL_TOOL_TOKEN, then the saved credential for the requested server. Set TWL_TOOL_CONFIG_HOME to override the local credential directory.

When the UI and API use different origins, add --api-url API_URL or set TWL_TOOL_API_URL.

Authoring​

npx twl-tool build twl-tool.app.ts --out twl-tool.app.json
npx twl-tool validate twl-tool.app.ts --url APP_URL
npx twl-tool plan twl-tool.app.ts --url APP_URL --organization ORG
npx twl-tool deploy twl-tool.app.ts --url APP_URL --organization ORG

Testing​

npx twl-tool test twl-tool.tool.test.ts
npx twl-tool certify twl-tool.tool.test.ts --out certification.json

Clone a Space Template​

npx twl-tool clone TEMPLATE_ID \
  --url APP_URL \
  --organization ORG \
  --out twl-tool.app.json \
  --key my-template-fork \
  --name "My Template Fork"

The clone is editable and retains source provenance. The developer-managed original remains unchanged.

Browser listener operations​

npx twl-tool browser-status --url APP_URL --organization ORG
npx twl-tool listener-discover-start discovery.json --url APP_URL --organization ORG
npx twl-tool listener-preview selector.json --url APP_URL --organization ORG
npx twl-tool listener-activate AUTOMATION_ID --url APP_URL --organization ORG
npx twl-tool listener-verify WATCHER_ID --url APP_URL --organization ORG --payload