> ## Documentation Index
> Fetch the complete documentation index at: https://forest-chore-open-api.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Reference

> Agent SDKs, public API, CLI, and schema format.

Technical reference for everything programmable in Forest, the agent SDKs, the public API, the Forest CLI, and the `.forestadmin-schema.json` format.

<Note>
  Looking for the onboarding path instead? See **[Get started](/get-started/intro-to-forest-admin)**.
</Note>

## Agent SDK

The Forest Agent is the lightweight backend that connects Forest to your data. It runs in your infrastructure, executes your business logic, and exposes your data to operators and AI agents (via the MCP server).

<CardGroup cols={2}>
  <Card title="Node.js agent" icon="node-js" href="/reference/agent-api/nodejs">
    Complete API reference for `@forestadmin/agent`. TypeScript-first, multi-datasource, plugin ecosystem.
  </Card>

  <Card title="Ruby agent" icon="gem" href="/reference/agent-api/ruby">
    Complete API reference for the Forest Ruby agent. ActiveRecord and Mongoid support, Rails integration.
  </Card>
</CardGroup>

<Card title="Agent SDK overview" icon="circle-info" href="/reference/agent-api/overview">
  How agents fit into Forest's architecture, supported languages, and feature parity across SDKs.
</Card>

## CLI

The Forest CLI (`forest`) manages branches, environments, and deployments throughout your development workflow.

<Card title="CLI reference" icon="terminal" href="/reference/cli/overview">
  Authentication, branch management, deployment, environment commands, and Docker usage.
</Card>

Common commands:

<CardGroup cols={2}>
  <Card title="forest login" href="/reference/cli/login">
    Sign in to your Forest account.
  </Card>

  <Card title="forest init" href="/reference/cli/init">
    Initialize your local development environment.
  </Card>

  <Card title="forest branch" href="/reference/cli/branch">
    Create or list branches.
  </Card>

  <Card title="forest switch" href="/reference/cli/switch">
    Switch the active branch.
  </Card>

  <Card title="forest push" href="/reference/cli/push">
    Push layout changes to the branch's origin environment.
  </Card>

  <Card title="forest deploy" href="/reference/cli/deploy">
    Deploy layout changes to production.
  </Card>
</CardGroup>

## Public API

The Forest public API exposes activity logs, admin logs, and notes for programmatic access, useful for compliance, audit, and external integrations.

<Card title="Public API reference" icon="cloud-arrow-down" href="/reference/api/introduction">
  Authentication, rate limits, and available endpoints.
</Card>

<CardGroup cols={3}>
  <Card title="Activity logs" href="/reference/api/endpoints/activity-logs">
    List activity logs per project and environment.
  </Card>

  <Card title="Admin logs" href="/reference/api/endpoints/admin-logs">
    List admin operations across a project.
  </Card>

  <Card title="Notes" href="/reference/api/endpoints/notes">
    Read and write collaboration notes on records.
  </Card>
</CardGroup>

## Schema

<Card title=".forestadmin-schema.json" icon="file-code" href="/reference/schema/forestadmin-schema">
  Reference for the auto-generated schema file that describes your collections and customizations.
</Card>

## Migrating from a legacy agent?

If you're working with `forest-express-sequelize`, `forest-express-mongoose`, `forest-rails`, or `django-forestadmin v1`, see **[Migrating from v1](/guides/migration/from-v1/overview)**. The legacy agent reference is preserved in **[Legacy](/legacy/agents-overview)** for migration purposes.