Repository setup

opentide setup is the primary onboarding entry point. It can run interactively or non-interactively with --yes.

Interactive wizard

cd /path/to/detection-repo
opentide setup

The wizard uses arrow-key menus and checkboxes for repository metadata, platforms, CI workflow features, MCP hosts, and agent skill targets. Only the repository name is inferred from the current directory. Platforms are explicitly selected, CI starts at Configure later, and MCP/skills are opt-in.

Before writing, opentide displays the target and selected steps and asks for one confirmation. Existing destinations are therefore visible before setup updates them.

Scripted onboarding

One-shot (parent --platform runs setup platforms before CI when --ci is also set):

opentide setup --yes \
  --path ./detection-repo \
  --name "SOC Detections" \
  --org "Example Corp" \
  --description "Enterprise detection content" \
  --platform sentinel \
  --platform defender_for_endpoint \
  --ci github

Or step-by-step:

opentide setup platforms --sentinel --defender-for-endpoint --yes
opentide setup ci github --yes
opentide setup env --yes
opentide setup hooks --yes
opentide setup mcp --cursor --yes
opentide setup skills --yes --generic

In non-interactive environments, --yes confirms only the flags shown in the command. It never silently selects Sentinel, VS Code, a CI provider, or a generic agent target.

What gets created

Subcommand	Output
`setup repo`	`objects/{threats,objectives,rules}/`, README, `.gitignore`; `--platform` also writes enabled platform TOML
`setup platforms`	Enabled `.opentide/configurations/platforms/*.toml`
`setup ci`	GitHub / GitLab / Azure workflow files (discovers enabled platforms; sets `OPENTIDE_REPO_ROOT`). A share stage is written only with `--sharing`
`setup env`	`.env.example` with `OPENTIDE_REPO_ROOT`; ignores `.env`
`setup hooks`	`.pre-commit-config.yaml` plus validate-on-commit Git hook
`setup mcp`	Editor MCP config that runs `opentide mcp start`
`setup skills`	Agent skills: four authoring skills from the package, other slugs as the full opentidehq/skills tree (`discover`, `show`, install)

Expected layout after setup + generate

detection-repo/
├── objects/
│   ├── threats/
│   ├── objectives/
│   └── rules/
├── docs/                         # opentide generate docs output
├── .opentide/
│   ├── configurations/
│   │   └── platforms/
│   ├── schemas/                  # opentide generate schemas
│   ├── templates/
│   ├── exports/
│   └── states/
│       ├── deployment/           # vendor rule ids, committed (written by deploy)
│       └── sharing.jsonl         # sharing cache, gitignored
├── .github/workflows/            # when --ci github
├── .env.example                 # when setup env
├── README.md
└── AGENTS.md                     # when --skills generic

Client configuration overrides live under .opentide/configurations/. Package defaults ship in the PyPI wheel.

Scoped subcommands

Run individual setup steps when you only need one surface:

opentide setup repo --yes --name SOC --platform sentinel
opentide setup platforms --sentinel --yes
opentide setup ci github --yes
opentide setup env --yes
opentide setup hooks --yes
opentide setup mcp --cursor --yes
opentide setup skills discover
opentide setup skills --yes --generic --name SOC --org "Example Corp"

MCP and skills

MCP host flag	Config file
`--vscode`	`.vscode/mcp.json`
`--cursor`	`.cursor/mcp.json`
`--claude-code`	`.mcp.json`
`--generic`	`opentide.mcp.json`

Skills target	Output
`--cursor`	`.cursor/skills/<slug>/`
`--claude-code`	`CLAUDE.md`, `.claude/skills/`
`--generic`	`AGENTS.md`, `.agents/skills/`
`--github-copilot`	`.github/copilot-instructions.md`

See Agentic setup for details.

VS Code settings (deprecated)

opentide setup vscode generates templates and JSON schemas, then maps objects/**/*.yaml to the .opentide/schemas/opentide.schema.json router in yaml.schemas (see Schema revision), writes .vscode/extensions.json, and writes snippets — interim scaffolding until the opentide VS Code extension ships. Pass --mcp to also write .vscode/mcp.json via the same helper as opentide setup mcp --vscode. Both paths are valid; parent --vscode-setup does not imply MCP. A missing target directory is created before generate. Pass --no-generate to skip generation when artifacts already exist. The command fails if snippets were requested but could not be written.

CLI reference

Full flag list: CLI setup.

Next steps

opentide generate
opentide validate --strict
opentide setup mcp --cursor --yes   # if not done during setup

generate writes .opentide/templates/*.template.yaml from Pydantic models (required keys live, optional fields commented with # hugging each key, no YAML null). The metadata keys that opentide lint requires, author and organisation by default, are live too. Copy a template into objects/ or use the tide-threat / tide-objective / tide-rule VS Code snippets.

On this page