Generate a ready-to-run CrewX workspace in under 30 seconds:
npx crewx-quickstart
crewx q "@quickstart hi"The first command scaffolds the required configuration files, Slack helper script, and documentation. The second command talks to the freshly provisioned @quickstart agent powered by the CrewX CLI (assumed to be installed).
- ✨ Zero-friction setup – copy-and-edit
crewx.yamlwith helpful comments - 🤖 Custom agent included –
@quickstartis configured for immediate use - 💬 Slack ready –
.env.slackplaceholder + executablestart-slack.sh - 📝 Guided documentation – README outlines next actions and tips
- 🛡️ Safe overwrites – existing files are preserved unless
--forceis passed
npx crewx-quickstart [target-dir]
If target-dir is omitted, files are written into the current directory. The CLI will:
- Create
crewx.yaml,.env.slack,start-slack.sh,.gitignore, andREADME.md - Skip existing files unless you pass
--force - Print the two follow-up commands (
crewquery + optional Slack launch)
--force,-f– overwrite existing files--quiet,-q– suppress per-file logs (only success/failure output)
# Install dependencies (none required right now)
npm install
# Run the CLI locally
node bin/crewx-quickstart.js demo-projectMIT © Sowon Labs