LICENSE Documentation

Official TypeScript developer resources and documentation for agno-agi/LICENSE. Verified technical context for AI.

0 stars TypeScript TypeScript 1 file ยท ~64,239 tokens
RAW Doc

1. Project Overview & Quickstart (agno-agi/LICENSE)

1. Project Overview & Quickstart (agno-agi/LICENSE)

LICENSE

Open-source repository agno-agi/LICENSE

Repository Details

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

  1. Install the Mintlify CLI: npm i mint
  2. From the repo root (the folder with docs.json), run mint dev
  3. 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:

text
npm i mint

Run the following command at the root of your documentation (where docs.json is)

text
mint dev

Publishing Changes

Publish changes by pushing to the main branch via a PR.

text
git add .
git commit -m "update message"
git push

How to generate a new API reference

  1. In your local agno repo, run the AgentOS cookbook containing all supported interfaces, using the latest version of Agno.

    bash
    python cookbook/05_agent_os/interfaces/all_interfaces.py
  2. Download the latest API reference files:

    bash
    curl -o reference-api/openapi.json http://localhost:7777/openapi.json

    Using swagger-cli to create openapi.yaml counterpart:

    bash
    swagger-cli bundle reference-api/openapi.json --outfile reference-api/openapi.yaml --type yaml
  3. Delete all files in the reference-api/schema/ folder (the auto-generated files)

  4. Run npx @mintlify/scraping@latest openapi-file reference-api/openapi.json -o reference-api/schema to generate the new API reference

  5. Update the docs.json file to include any new pages.

  6. Run mint dev to see the changes

Troubleshooting

  • Mintlify dev isn't running - Run mint update it'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):

text
ln -s ~/code/agno agno

For agno engineers, also symlink the specs repo:

text
ln -s ~/code/specs specs

2. Official Technical Reference & Guides (agno-agi/docs)

Agno Docs

Agno documentation site built with Mintlify.

Quickstart

  1. Install the Mintlify CLI: npm i mint
  2. From the repo root (the folder with docs.json), run mint dev
  3. 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:

text
npm i mint

Run the following command at the root of your documentation (where docs.json is)

text
mint dev

Publishing Changes

Publish changes by pushing to the main branch via a PR.

text
git add .
git commit -m "update message"
git push

How to generate a new API reference

  1. In your local agno repo, run the AgentOS cookbook containing all supported interfaces, using the latest version of Agno.

    bash
    python cookbook/05_agent_os/interfaces/all_interfaces.py
  2. Download the latest API reference files:

    bash
    curl -o reference-api/openapi.json http://localhost:7777/openapi.json

    Using swagger-cli to create openapi.yaml counterpart:

    bash
    swagger-cli bundle reference-api/openapi.json --outfile reference-api/openapi.yaml --type yaml
  3. Delete all files in the reference-api/schema/ folder (the auto-generated files)

  4. Run npx @mintlify/scraping@latest openapi-file reference-api/openapi.json -o reference-api/schema to generate the new API reference

  5. Update the docs.json file to include any new pages.

  6. Run mint dev to see the changes

Troubleshooting

  • Mintlify dev isn't running - Run mint update it'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):

text
ln -s ~/code/agno agno

For agno engineers, also symlink the specs repo:

text
ln -s ~/code/specs specs