zooid use
Fetches a template from a GitHub URL and adds it to your workforce as an included file.
npx zooid use <url>Arguments
Section titled “Arguments”| Argument | Description |
|---|---|
url | GitHub URL to a repo or subdirectory |
Examples
Section titled “Examples”# Add a chat templatenpx zooid use https://github.com/zooid-ai/templates/tree/master/chat
# Add a monitoring templatenpx zooid use https://github.com/zooid-ai/templates/tree/master/monitoring
# Add from a repo rootnpx zooid use https://github.com/zooid-ai/trading-deskWhat happens
Section titled “What happens”- Fetches the template repo/subdirectory as a tarball.
- Reads
meta.slugfrom the template’s workforce.json for the directory name. Falls back to the URL path. - Copies the entire
.zooid/directory from the template into.zooid/<slug>/. - Adds
"./<slug>/workforce.json"to theincludearray in your workforce.json.
Result
Section titled “Result”.zooid/├── workforce.json # include: ["./chat/workforce.json"]└── chat/ └── workforce.json # the template's workforceThe template’s channels and roles are now part of your resolved workforce. Run zooid deploy to sync them to the server.
Naming
Section titled “Naming”The directory name is determined by:
meta.slugin the template’s workforce.json (preferred).- Last segment of the URL path (fallback).
- Repo name if no subpath (fallback).
- Templates are just workforce files. Edit them, delete them, reorganize them.
- If the template has internal
includereferences, they resolve correctly because the entire.zooid/directory is copied. - To remove a template, delete its directory and remove it from
include. - Also available as
zooid init --use <url>to combine init and use in one step.