akka specify init

Initialize a new Akka project for AI-assisted development.

Synopsis

Initialize a project with everything needed for AI-assisted Akka development. This command:

  1. Clones an Akka sample project (or uses the current directory with '.')

  2. Downloads the Akka SDK constitution (and additional constitution, if configured)

  3. Installs SDD templates, and (when --agent selects a slash-command harness) per-harness slash commands / rules

  4. Configures the MCP server for AI agent integration

The install surface varies by --agent: neutral / generic / factory / devin / junie / warp / jules / zed / codex / copilot-agent get AGENTS.md and rely on the Akka MCP tools directly; claude-code / cursor / vscode-copilot / vs-copilot / roo / trae / agy also get per-harness slash commands or rules.

Building the project requires the Akka resolver in your Maven settings.xml. If not yet configured, this command will guide you through setup before initializing the project. Use --skip-token-check to bypass this check (useful in scripts or pre-provisioned container environments where Maven is already configured, e.g. via an internal mirror).

After running this command, open your AI coding agent (Claude Code, Cursor, Copilot, Zed, Warp, …​) in the project directory to start developing.

Examples: akka specify init my-service --agent claude-code # clone sample; Claude Code profile cd my-service && claude

akka specify init . # neutral install in cwd # then open your preferred AGENTS.md-aware agent

akka specify init [directory] [flags]

Options

      --agent string             AI agent to configure (omit for AGENTS.md + .mcp.json only).
                                   Verified profiles:
                                     claude-code, cursor, vscode-copilot, agy, roo, trae, vs-copilot.
                                   AGENTS.md-native (writes a project MCP file):
                                     generic, factory, devin, junie.
                                   AGENTS.md-native aliases (MCP registered outside the workspace — CLI prints the vendor-specific hint):
                                     warp, jules, zed, copilot-agent, codex.
                                   Scaffolded (installs agent-neutral files with a warning):
                                     kilo, cline, replit, jetbrains-copilot, xcode-copilot, nvim-copilot.
      --channel string           Release channel for AI marketplace + constitution: stable (default; blessed tag) or edge (main branch).
  -h, --help                     help for init
      --marketplace-ref string   Override AI marketplace git ref (branch, tag, or commit SHA).
      --skip-commands            Skip slash-command installation (use when commands are provided by a plugin).
      --skip-token-check         Skip the Maven resolver/token check (for scripted or pre-provisioned environments).

Options inherited from parent commands

      --cache-file string   location of cache file (default "~/.akka/cache.yaml")
      --config string       location of config file (default "~/.akka/config.yaml")
      --context string      configuration context to use
      --disable-prompt      Disable all interactive prompts when running akka commands. If input is required, defaults will be used, or an error will be raised.
                            This is equivalent to setting the environment variable AKKA_DISABLE_PROMPTS to true.
  -o, --output string       set output format to one of [text,json,json-compact,go-template=] (default "text")
      --page-mode string    the mode for paging, either paged, buffered or auto. (default "auto")
  -q, --quiet               set quiet output (helpful when used as part of a script)
      --timeout duration    client command timeout (default 10s)
      --use-grpc-web        use grpc-web when talking to Akka APIs. This is useful when behind corporate firewalls that decrypt traffic but don't support HTTP/2.
      --verbose             set verbose output

SEE ALSO

  • akka specify - [Incubating] Initialize and manage AI-assisted Akka development projects.