AdaL CLI Documentation
About
This is the public documentation site for AdaL CLI. AdaL is an agentic coding tool that runs in your terminal, created by SylphAI and named after Ada Lovelace, the world's first programmer.
What you can do here:
- Report issues with AdaL CLI agent behavior
- Suggest documentation fixes or improvements
- Contribute to make the docs better
Install AdaL CLI
npm install -g @sylphai/adal-cli
# cd to your working directory and run
adal
Requires Node.js 20+. See Quickstart for details.
🐛 Reporting Issues
Found a bug or something wrong in the docs?
Please include:
- What you expected vs what happened
- Steps to reproduce (if applicable)
- AdaL CLI version (
adal -v) - OS and terminal
📝 Contributing
We welcome documentation improvements!
Quick Edits
- Find the page you want to fix at docs.sylph.ai
- Locate the corresponding file in
docs-site/docs/ - Edit and submit a PR
Running Locally
cd docs-site
npm install
npm run start # Dev server at http://localhost:3000
npm run build # Production build
Guidelines
- Keep docs clear and concise
- Test changes locally with
npm run build - Follow existing formatting conventions
Project Structure
docs-site/
├── docs/ # Documentation pages (markdown)
│ ├── 01-getting-started/ # Quickstart, models, workflows
│ ├── 03-features/ # Feature docs (shortcuts, commands, skills)
│ ├── 07-troubleshooting/ # Common issues and solutions
│ └── build-with-adal/ # Advanced usage
├── static/ # Images and assets
└── src/ # Custom CSS and components
Links
- Docs: docs.sylph.ai
- GitHub: github.com/SylphAI-Inc/adal-cli
- X (Twitter): @adalengineer
- Discord: Join our community
- SylphAI: sylph.ai
Built with Docusaurus by AdaL & SylphAI