.forestadmin-schema.json format.
Looking for the onboarding path instead? See Get started.
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).Node.js agent
Complete API reference for
@forestadmin/agent. TypeScript-first, multi-datasource, plugin ecosystem.Ruby agent
Complete API reference for the Forest Ruby agent. ActiveRecord and Mongoid support, Rails integration.
Agent SDK overview
How agents fit into Forest’s architecture, supported languages, and feature parity across SDKs.
CLI
The Forest CLI (forest) manages branches, environments, and deployments throughout your development workflow.
CLI reference
Authentication, branch management, deployment, environment commands, and Docker usage.
forest login
Sign in to your Forest account.
forest init
Initialize your local development environment.
forest branch
Create or list branches.
forest switch
Switch the active branch.
forest push
Push layout changes to the branch’s origin environment.
forest deploy
Deploy layout changes to production.
Public API
The Forest public API exposes activity logs, admin logs, and notes for programmatic access, useful for compliance, audit, and external integrations.Public API reference
Authentication, rate limits, and available endpoints.
Activity logs
List activity logs per project and environment.
Admin logs
List admin operations across a project.
Notes
Read and write collaboration notes on records.
Schema
.forestadmin-schema.json
Reference for the auto-generated schema file that describes your collections and customizations.
Migrating from a legacy agent?
If you’re working withforest-express-sequelize, forest-express-mongoose, forest-rails, or django-forestadmin v1, see Migrating from v1. The legacy agent reference is preserved in Legacy for migration purposes.