Getting Started
Install
bash
npm install -g create-polyglotScaffold a Project
bash
create-polyglot init my-org -s node,python,go,java,frontend --git --yesIf you omit flags (or drop --yes), the wizard prompts for missing values and lets you rename services + adjust ports.
Directory Layout
my-org/
services/
node/ python/ go/ java/ frontend/
packages/shared
polyglot.json
compose.yaml
package.jsonDev Workflow
bash
cd my-org
npm run dev # starts Node-based dev scripts (scans services/)Non-Node services (Python/Go/Java) start manually or via Docker compose:
bash
docker compose up --buildAdd a Service Later
bash
create-polyglot add service reporting --type python --port 5050Add a Plugin
bash
create-polyglot add plugin authHot Reload
Enable automatic restart on file changes:
bash
create-polyglot hotThis monitors all services and automatically restarts them when files change.
Admin Dashboard
Launch the admin dashboard to manage services:
bash
create-polyglot adminThe dashboard provides:
- Real-time log streaming
- Service start/stop/restart controls
- Health monitoring
- WebSocket updates
Next Steps
- Learn about Presets (Turborepo, Nx, Basic)
- Explore Docker & Compose workflows
- Create Shared Libraries for code reuse
- Extend with Plugins
- Read the CLI Reference for all commands
Common Commands
bash
# List all services
create-polyglot services
# View service logs
create-polyglot logs <service-name>
# Start specific service
create-polyglot start <service-name>
# Stop specific service
create-polyglot stop <service-name>
# Remove a service
create-polyglot remove service <service-name>
# Add a shared library
create-polyglot add lib <name> --type python
# List all libraries
create-polyglot librariesTroubleshooting
If you encounter issues:
- Check the Troubleshooting Guide
- Verify Node.js version:
node --version(should be 18+) - Check for port conflicts:
lsof -i :<port> - View logs:
create-polyglot logs --all - Enable debug mode:
DEBUG=* create-polyglot init test
Get Help
- 📖 Read the complete documentation
- 💬 Ask in GitHub Discussions
- 🐛 Report bugs in GitHub Issues