1. Project Overview & Quickstart (agno-agi/LICENSE)
1. Project Overview & Quickstart (agno-agi/LICENSE)
LICENSE
Open-source repository agno-agi/LICENSE
Repository Details
- Repository: agno-agi/LICENSE
- Primary Language: Code
Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.
2. Official Technical Reference & Guides (agno-agi/docs)
Agno Docs
Agno documentation site built with Mintlify.
Quickstart
- Install the Mintlify CLI:
npm i mint - From the repo root (the folder with
docs.json), runmint dev - Open the local site at
http://localhost:3000
Contributing
We welcome contributions to improve the Agno documentation! Please read our CONTRIBUTING.md for detailed guidelines on:
- How to set up your development environment
- Pull request and branch naming conventions
- Documentation structure and writing guidelines
- Testing and validation procedures
Development
Install the Mintlify CLI to run the documentation site locally:
npm i mintRun the following command at the root of your documentation (where docs.json is)
mint devPublishing Changes
Publish changes by pushing to the main branch via a PR.
git add .
git commit -m "update message"
git pushHow to generate a new API reference
In your local
agnorepo, run theAgentOScookbook containing all supported interfaces, using the latest version of Agno.bashpython cookbook/05_agent_os/interfaces/all_interfaces.pyDownload the latest API reference files:
bashcurl -o reference-api/openapi.json http://localhost:7777/openapi.jsonUsing swagger-cli to create openapi.yaml counterpart:
bashswagger-cli bundle reference-api/openapi.json --outfile reference-api/openapi.yaml --type yamlDelete all files in the
reference-api/schema/folder (the auto-generated files)Run
npx @mintlify/scraping@latest openapi-file reference-api/openapi.json -o reference-api/schemato generate the new API referenceUpdate the
docs.jsonfile to include any new pages.Run
mint devto see the changes
Troubleshooting
- Mintlify dev isn't running - Run
mint updateit'll update dependencies. - Page loads as a 404 - Make sure you are running in a folder with
docs.json
AI Powered Development
First, symlink the agno repo (gitignored):
ln -s ~/code/agno agnoFor agno engineers, also symlink the specs repo:
ln -s ~/code/specs specs2. Official Technical Reference & Guides (agno-agi/docs)
Agno Docs
Agno documentation site built with Mintlify.
Quickstart
- Install the Mintlify CLI:
npm i mint - From the repo root (the folder with
docs.json), runmint dev - Open the local site at
http://localhost:3000
Contributing
We welcome contributions to improve the Agno documentation! Please read our CONTRIBUTING.md for detailed guidelines on:
- How to set up your development environment
- Pull request and branch naming conventions
- Documentation structure and writing guidelines
- Testing and validation procedures
Development
Install the Mintlify CLI to run the documentation site locally:
npm i mintRun the following command at the root of your documentation (where docs.json is)
mint devPublishing Changes
Publish changes by pushing to the main branch via a PR.
git add .
git commit -m "update message"
git pushHow to generate a new API reference
In your local
agnorepo, run theAgentOScookbook containing all supported interfaces, using the latest version of Agno.bashpython cookbook/05_agent_os/interfaces/all_interfaces.pyDownload the latest API reference files:
bashcurl -o reference-api/openapi.json http://localhost:7777/openapi.jsonUsing swagger-cli to create openapi.yaml counterpart:
bashswagger-cli bundle reference-api/openapi.json --outfile reference-api/openapi.yaml --type yamlDelete all files in the
reference-api/schema/folder (the auto-generated files)Run
npx @mintlify/scraping@latest openapi-file reference-api/openapi.json -o reference-api/schemato generate the new API referenceUpdate the
docs.jsonfile to include any new pages.Run
mint devto see the changes
Troubleshooting
- Mintlify dev isn't running - Run
mint updateit'll update dependencies. - Page loads as a 404 - Make sure you are running in a folder with
docs.json
AI Powered Development
First, symlink the agno repo (gitignored):
ln -s ~/code/agno agnoFor agno engineers, also symlink the specs repo:
ln -s ~/code/specs specs