Studio · Install and configure

Installation overview

We recommend using a local Coding Agent, such as Claude Code or Codex, to install and configure Studio. If you already have an invitation, go to Get started.

Set up with an Agent

Prompt
Follow https://docs.nocobase.com/studio/setup/ to install NocoBase Studio and configure my first project.

The Agent checks the target environment, asks for missing information, and follows the steps below to configure and verify the setup. Follow its prompts when sign-in or authorization requires your participation.

Before you begin

This guide uses Docker Compose, GitHub, and one shared runtime. Prepare:

  • Image access: Studio is a commercial product. Contact us for the image and access authorization.
  • Deployment environment: Server access and a URL for Studio. A local trial does not need a domain.
  • Git account: A GitHub account or organization where you can create repositories and install a GitHub App.
  • Coding tools and model accounts: For example, Claude Code or Codex. You can keep using existing accounts.

The Agent can install and configure the software. Reuse existing databases, reverse proxies, storage, or email services where suitable. The Agent asks for any missing information.

We recommend a separate container or virtual machine for the runtime, isolated from Studio. Install the coding tools and runner inside that environment.

Prepare the team environment

StepResult
1. Deploy StudioAdministrators can sign in
2. Connect a Git platformStudio can create repositories and submit code
3. Connect a runtimeCoding tools are online and ready to work
4. Configure AgentsThe Lead Agent can assign work
5. Create your first projectThe application code is initialized
6. Configure checks and previewsSelect Agent self-checks or CI to verify changes
7. Invite membersMembers can accept invitations and join the project

Members start work

After accepting an invitation and signing in, members walk through their first request: submit a requirement, follow development, and accept the result. They can use the team's runtime without connecting their own computers.

Adjust configuration

SettingDocumentation
Model responsibilities, execution machines, and shared skillsAgent management: Agents, Runtimes, and Skills
Check sources and CI pipelinesQuality management: Checks and CI
Project information, members, and default skillsProject management: Project settings
Git connections and other code platformsAdministration: Code platforms
Databases, access URLs, and deployment parametersReference: Configuration

NocoBase docs assistant

Ask anything about NocoBase…

Each question is answered independently, without earlier questions or answers. Include all relevant context.