Skip to content

Projects ​

A project in Contentrain Studio connects a GitHub repository to the content management system. Each project has its own content models, entries, branches, media library, and team members.

Creating a Project ​

There are two ways to create a project from your workspace dashboard.

Connecting an Existing Repository ​

Use this option when you already have a repository (with or without Contentrain configuration):

  1. From the workspace dashboard, click Connect repository
  2. If the GitHub App is not installed, you will be prompted to install it first
  3. Select a repository from the list of available repos
  4. Studio scans the repository for existing .contentrain/ configuration
  5. Review the scan results (detected stack, existing content, i18n settings)
  6. Click Connect to create the project

The Connect repository dialog: a search box filtering the accessible repositories, each with its description and language

The dialog follows a state machine flow:

StepWhat Happens
InstallShown if no GitHub App installation exists — links to GitHub App setup, or to Connect an existing installation
Connect existing installationPick a GitHub App installation you already have on your account or organization and link it to this workspace
SelectBrowse and search your repositories, filter by name
ConfirmReview scan results (stack detection, content directory) and confirm

TIP

You can search your repositories by name in the selection step. Studio shows the repository name, visibility (public/private), default branch, language, and last update date.

Starting from a Template ​

Use this option to create a new repository from a pre-configured starter kit:

The "Start from Template" dialog: starter kits filtered by framework (Astro, Next.js, Nuxt, SvelteKit, VitePress), each with a description and tags

  1. From the workspace dashboard, click Use Template
  2. Browse available starter kits, optionally filter by framework
  3. Select a template
  4. Enter a repository name and choose visibility (public/private)
  5. Studio creates the repository from the template and connects it as a project

Available framework filters are Astro, Next.js, Nuxt, SvelteKit, and VitePress.

GitHub App Requirements ​

Studio requires the Contentrain GitHub App to be installed on your GitHub account or organization:

  • Repository access: The app needs read/write access to repository contents and metadata
  • Selective access: You can choose which repositories the app can access
  • Organization support: Install on your personal account or any organization you administer
  • Reconfiguration: You can change repository access at any time from GitHub settings

WARNING

Without the GitHub App installation, you cannot connect repositories or create projects. The workspace dashboard will show an empty state prompting you to install the app.

The Three-Panel Layout ​

When you open a project, Studio presents a three-panel workspace:

The three-panel project layout Sidebar, resizable: models grouped by domain, Vocabulary, CDN, Media and Pending changes. Chat panel: the AI conversation with its tool calls. Content panel: browse and edit content entries. Drag the divider between the chat and content panels to resize them. Sidebar Models (by domain) Vocabulary CDN Media Pending changes ↔ resizable Chat panel AI conversation with tool calls save_content ✓ Content panel Browse and edit content entries ↔ drag the divider

The sidebar provides navigation for the project:

  • Models: List of all content models, grouped by domain
  • Vocabulary: Project-wide vocabulary terms
  • CDN Delivery: Content delivery settings (when CDN delivery is available on your plan; otherwise shown locked)
  • Assets: Asset library (when the media library is available on your plan; otherwise shown locked)
  • Pending Changes: cr/* content branches awaiting review
  • Project Settings: a gear icon in the project header, visible to workspace owners and admins only

The sidebar and the Content Panel are resizable by dragging their dividers; the sidebar defaults to 240px and the Content Panel to 384px, and double-clicking the Content Panel divider collapses it.

Clicking a model in the sidebar opens it in the Content Panel. Clicking a pending change opens the branch diff viewer.

Chat Panel ​

The center panel is the AI conversation interface. You can:

  • Send messages to the AI agent
  • View tool call results inline
  • Switch between AI models (Haiku, Sonnet, Opus)
  • Pin context items from the Content Panel
  • Browse conversation history

See AI Chat for the full guide.

Content Panel ​

The right panel displays content based on your current context:

  • Overview: Project summary with model list and entry counts
  • Model view: Content entries for the selected model
  • Branch view: Visual diff of changes on a branch
  • Vocabulary view: Key-value term editor

See Content Editing for details.

Project Initialization ​

When you connect a repository that does not have a .contentrain/ directory, the project enters an uninitialized state. You can initialize it in two ways:

Via Chat ​

Ask the AI agent to initialize the project:

"Initialize this project with a blog collection model and English locale"

The agent will create the .contentrain/ configuration structure, including config.json, model definitions, and empty content files.

Via Starter Template ​

If you created the project from a starter template, it comes pre-initialized with models and sample content.

Project Settings ​

Workspace owners and admins can open project settings from the gear icon in the sidebar's project header or through the command palette. The modal is organized into tabs:

  • General: workflow mode (auto-merge or review), supported locales and the default locale, and content domains
  • Media: media rehost, which rewrites content onto this instance's CDN delivery URLs (shown only when CDN delivery is available and you are an owner or admin)
  • API keys: two sections. MCP keys let an MCP client (Cursor, Claude Code, CI) read and write this project; the tab shows how many of the workspace's keys are used. Conversation API keys (Pro and Enterprise) let your own app talk to the project's AI agent. Workspace owners and admins create and revoke keys; members see a note that admins manage them. Plans without a feature show an upgrade prompt in its section.
  • Webhooks: outbound webhook endpoints, with pause and resume per endpoint (Starter and above, Enterprise Edition)
  • Danger zone: delete the project (removes it from Studio; the repository itself is not deleted)

Project-level member assignment (Editor / Reviewer / Viewer) lives in Workspace Settings → Members → Project Access, not here.

Project Settings — the General tab showing the workflow mode (auto-merge vs review), supported locales, and the default locale

Project Health ​

Studio tracks project health metrics including:

  • Content validation status
  • Model schema consistency
  • Branch count and cleanup recommendations
  • Locale parity across models

Open the health dashboard from the project overview (click the health score on the stats bar, or View Details on the schema warning banner) or the command palette (Project health). The sidebar only shows a small colored dot next to the project name when the score is below 90.

The Project Health view: an overall score with critical, error, and warning counts, and a validation summary

Deleting a Project ​

To delete a project:

  1. Open project settings
  2. Scroll to the Danger Zone
  3. Click Delete Project
  4. Type the repository name to confirm

WARNING

Deleting a project removes it from Studio and permanently deletes its conversations, CDN builds, media assets, and cached content. The GitHub repository itself is not deleted.

Next Steps ​

Released under the AGPL-3.0 License. Privacy