Skip to content

The self-evolving coding agent that learns from your entire team and codebase. Less syncing. Less waiting. Deliver at the speed of thought.

Notifications You must be signed in to change notification settings

SylphAI-Inc/adal-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

129 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AdaL CLI Documentation

AdaL Face      AdaL Text

Your self-evolving agent for engineering and research

Docs Discord X


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?

Open an Issue →

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

  1. Find the page you want to fix at docs.sylph.ai
  2. Locate the corresponding file in docs-site/docs/
  3. 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


Built with Docusaurus by AdaL & SylphAI

About

The self-evolving coding agent that learns from your entire team and codebase. Less syncing. Less waiting. Deliver at the speed of thought.

Topics

Resources

Stars

Watchers

Forks

Contributors 6