# summary

Initialize setup-agents workspace configuration.

# description

Creates `.setup-agents/config.json` in the current project directory with default setup-agents workspace settings.

The config stores the plugin version, workspace mode, selected profiles, selected tools, and native orchestration settings.

Use project mode for a normal repository workspace. Use advisory mode for consultative setup defaults outside a project workspace.

# flags.mode.summary

Workspace mode to persist.

# flags.mode.description

Set the workspace mode stored in `.setup-agents/config.json`. Valid options are `project` and `advisory`.

# flags.advisory.summary

Persist advisory mode.

# flags.advisory.description

Shortcut for `--mode advisory`.

# flags.profile.summary

Role profiles to persist (comma-separated).

# flags.profile.description

Specify one or more role profiles as a comma-separated list.

When omitted, the command runs a short guided onboarding: first a role question, then a clouds/products question, then an optional advanced full-list picker. If no profile is selected, `developer` is used as the default.

# flags.tools.summary

AI tools to persist (comma-separated).

# flags.tools.description

Specify one or more AI coding tools as a comma-separated list. Valid options are `cursor`, `vscode`, `codex`, `claude`, or `agentforce`.

When omitted, the command auto-detects tools present in the project; if none are found, all supported tools are stored.

# flags.force.summary

Overwrite existing workspace config.

# flags.force.description

Force overwrite of `.setup-agents/config.json` if it already exists.

# flags.commit.summary

Add team setup note to README.md.

# flags.commit.description

After writing `.setup-agents/config.json`, appends a short "Team Setup" section to `README.md` (creates it if missing) instructing teammates to run `sf setup-agents local` after cloning to generate their AI rule files from the committed config.

# examples

- Initialize project workspace config with detected defaults:

  <%= config.bin %> <%= command.id %>

- Initialize advisory workspace config:

  <%= config.bin %> <%= command.id %> --mode advisory

- Initialize with explicit profiles and tools:

  <%= config.bin %> <%= command.id %> --profile developer,architect --tools codex,claude

- Recreate an existing config:

  <%= config.bin %> <%= command.id %> --force

- Initialize and add team setup instructions to README.md:

  <%= config.bin %> <%= command.id %> --commit

# info.fileCreated

Created: %s

# info.done

Workspace config initialized. Mode: %s. Profiles: %s. Tools: %s.

# warn.fileExists

Skipped (already exists): %s

# warn.profileDefault

No profile selected. Using default: developer.

# warn.unknownProfiles

Unknown profile(s): %s. Valid profiles: %s

# warn.unknownTools

Unknown tool(s): %s. Valid tools: %s

# info.readmeUpdated

Team setup note added to %s. Commit .setup-agents/config.json and README.md so teammates get the same profile set automatically.

# info.readmeCreated

Created %s with team setup instructions.

# prompt.selectProfiles

Select your role profile(s):

# prompt.confirmCGCloud

Consumer Goods Cloud (cgcloud\_\_) namespace detected. Add CGCloud profile?

# prompt.onboarding.roles

What roles are active on this project? (select all that apply)

# prompt.onboarding.clouds

Which Salesforce clouds or products are in scope? (select all that apply)

# prompt.onboarding.advanced

Configure advanced profile selection?

# prompt.onboarding.advanced.no

No — use my selections above

# prompt.onboarding.advanced.yes

Yes — pick from the full profile list

# info.runningLocal

Generating rule files for your tools...

# flags.dry-run.summary

Preview changes without writing.

# flags.dry-run.description

Show what would be written without modifying any files.

# flags.quick.summary

Auto-detect everything and generate rules immediately.

# flags.quick.description

Skip all interactive prompts. Auto-detects tools from the project directory and profiles from project signals (e.g. sfdx-project.json, force-app/, package.json). Writes config and generates rule files in one step. Equivalent to running init + local with auto-detected defaults.
