Documentation index: /llms.txt. Each page is also available as Markdown by adding .md to its URL.

Skip to content
Brief

brief init

Create a Brief project and choose its framework, content format, and package manager.

Create a Brief project

Usage#

Arguments#

[DIR]Default undefined
string

Directory to create; prompted when omitted

Options#

-V, --versionDefault undefined
boolean

output the version number

-y, --yesDefault undefined
boolean

Do not prompt; require a project directory

--skip-installDefault undefined
boolean

Generate files without installing dependencies or preparing types

--disable-gitDefault undefined
boolean

Skip Git initialization and the initial commit

--no-agents-mdDefault true
boolean

Skip AGENTS.md and CLAUDE.md generation

--use-npmDefault undefined
boolean

Install with npm

--use-pnpmDefault undefined
boolean

Install with pnpm

--use-yarnDefault undefined
boolean

Install with Yarn

--use-bunDefault undefined
boolean

Install with Bun

--no-skillsDefault true
boolean

Skip project-local Brief agent skills

-c, --case <dir>Default undefined
string

Existing Brief workspace folder to build around; defaults to a starter workspace

--search <minisearch|none>Default undefined
"minisearch" | "none"

Search backend to scaffold; defaults to minisearch

-h, --helpDefault undefined
boolean

Display the concise help for this command

Global options are also accepted.