Your CLI agent for engineering and research

View Docs · Report Issue · Contribute

This is the public documentation site for AdaL CLI, built with Docusaurus. We welcome community contributions!

What you can do here:

• Report issues with AdaL CLI agent behavior
• Suggest documentation fixes or improvements
• Contribute to make the docs better

Found a bug with AdaL CLI or notice something wrong in the docs?

Open an Issue

Please include:

• What you expected vs what happened
• Steps to reproduce (if applicable)
• AdaL CLI version (adal -v)
• OS and terminal

We appreciate documentation improvements! Here's how:

1. Navigate to the doc you want to fix at adal-cli-docs.onrender.com
2. Note the page path (e.g., /features/slash-commands)
3. Find the corresponding file in docs-site/docs/
4. Edit and submit a PR

cd docs-site

# Install dependencies
npm install

# Start development server (opens http://localhost:3000)
npm run start

# Build for production
npm run build

• Keep docs clear and concise
• Test your changes locally with npm run build
• Follow existing formatting conventions

docs-site/
├── docs/                    # Documentation pages (markdown)
│   ├── 01-getting-started/  # Quickstart, installation
│   ├── 03-features/         # Feature documentation
│   ├── 07-troubleshooting/  # Common issues
│   └── build-with-adal/     # Advanced usage
├── static/                  # Images and assets
└── src/                     # React components, custom CSS

• Docs Site: adal-cli-docs.onrender.com
• AdaL CLI: github.com/SylphAI-Inc/adal-cli
• Follow AdaL: github.com/adal-cli
• Discord: Join our community