Skip to content

azldev_docs_agent_install.md

Latest commit

 

History

History
75 lines (55 loc) · 3.07 KB

azldev_docs_agent_install.md

File metadata and controls

75 lines (55 loc) · 3.07 KB
Raw

azldev docs agent install

Write azldev agent skill and instruction files into a repository

Synopsis

Write AI agent files describing how to use azldev into a target repository.

Creates (or overwrites) the generated agent substrate, relative to the output directory:

.agents/skills//SKILL.md one Agent Skill per built-in skill .github/instructions/.instructions.md path-specific instruction wrappers .mcp.json registers the azldev MCP server for Copilot .vscode/mcp.json registers the azldev MCP server

Everything azldev writes is generated deterministically, so re-running install is a no-op once committed — a CI check can run install and assert an empty diff. The MCP entries are upserted, preserving any other servers already configured.

By default the emitted SKILL.md is a light wrapper that points agents at the read-only 'docs-agent-show' MCP tool for the full, always-current skill. Pass --full to inline the complete skill instead, for environments without the azldev MCP server.

Directory paths in the emitted content (such as the lock and rendered-spec directories) are resolved from the loaded azldev.toml, falling back to azldev's built-in defaults when no configuration is found. The bindings reflect the project azldev runs in, so pair --output-dir with -C pointing at the target repository when scaffolding a different repo.

azldev docs agent install [flags]

Examples

  # Write agent files into the current repository
  azldev docs agent install

  # Write into a specific repository, inlining the full skill
  azldev docs agent install -o ../other-repo --full

Options

      --full                inline the full skill into SKILL.md instead of a light MCP wrapper
  -h, --help                help for install
      --layout string       skill layout: 'agents' (.agents/skills) or 'github' (.github/skills) (default "agents")
  -o, --output-dir string   target repository directory to write agent files into (default ".")

Options inherited from parent commands

  -y, --accept-all                accept all prompts
      --color mode                output colorization mode {always, auto, never} (default auto)
      --config-file stringArray   additional TOML config file(s) to merge (may be repeated)
  -n, --dry-run                   dry run only (do not take action)
      --network-retries int       maximum number of attempts for network operations (minimum 1) (default 3)
      --no-default-config         disable default configuration
  -O, --output-format fmt         output format {csv, json, markdown, table} (default table)
      --permissive-config         do not fail on unknown fields in TOML config files
  -C, --project string            path to Azure Linux project
  -q, --quiet                     only enable minimal output
  -v, --verbose                   enable verbose output

SEE ALSO