Skip to content

Commit 602e0a1

Browse files
docs(skills): document the skills installer and dhq skills command (#29)
* docs(skills): document the skills installer and dhq skills command PRs #25 (dhq launch) and #26 (skills installer) merged, but only launch made it into the docs. Bring the skills installer up to date: - Quick Start: note that dhq hello now offers to install the DeployHQ skill into detected agents, and add a standalone 'dhq skills install'. - Command list: add 'dhq skills list | install'. - Agent Integration: lead with 'dhq skills install' (auto-detects 12 agents, native formats, user vs project scope), and frame 'dhq setup' as the narrower per-agent alternative. - CLAUDE.md: add internal/skillinstaller/ to the architecture map. - hello.go: extend the command's long description to mention the skill install step so --help matches the new behaviour. Docs-only (plus the one help string); no behaviour change. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs(skills): fix scope overpromise and agent display names Address Review Council findings on PR #29: - Quick Start + hello.go no longer imply bare 'dhq skills install' / 'dhq hello' cover project-scope agents. Copilot is ScopeProject and is skipped by the bare command (opt-in via --agent), which the prose now reflects instead of contradicting the Agent Integration section. - Align the supported-agent list with the CLI display names: Continue -> Continue.dev, Kiro -> Kiro CLI (as shown by 'dhq skills list'). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 902a45f commit 602e0a1

3 files changed

Lines changed: 48 additions & 5 deletions

File tree

CLAUDE.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,12 @@ internal/commands/ All CLI commands (42 top-level, 155+ total)
3636
3737
internal/version/ Update checker (GitHub releases API)
3838
39+
internal/skillinstaller/ Detects installed AI agents (12 supported) and
40+
installs the DeployHQ skill into each one's native format.
41+
user-scope targets write to $HOME; project-scope targets
42+
write into the repo (opt-in via --agent). Powers
43+
`dhq skills` and the `dhq hello` onboarding step.
44+
3945
skills/deployhq/ Agent skill guide + per-domain reference docs (8 files)
4046
SKILL.md is the entry point for any AI agent.
4147

README.md

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,19 @@ dhq update
4848
# (Static Hosting or a Managed VPS) and deploy — to a live URL.
4949
dhq launch
5050

51-
# Guided setup (login or signup, pick a project, optional first deploy)
51+
# Guided setup (login or signup, pick a project, install the DeployHQ
52+
# skill into your AI coding agents, optional first deploy)
5253
dhq hello
5354

5455
# Or step-by-step
5556
dhq signup
5657
dhq auth login
5758
dhq configure
5859

60+
# Teach your detected AI coding agents (Claude Code, Cursor, Codex, …) to drive dhq
61+
# (project-scope agents like Copilot are opt-in — see `dhq skills install --agent`)
62+
dhq skills install
63+
5964
# Deploy and watch in real-time
6065
dhq deploy -p my-app --wait
6166

@@ -178,6 +183,7 @@ dhq assist [question] (AI deployment assistant, requires Ollama)
178183
dhq completion bash | zsh | fish | powershell
179184
dhq doctor (health check)
180185
dhq update (self-update to latest version)
186+
dhq skills list | install (auto-detect AI agents and install the DeployHQ skill)
181187
dhq setup claude | codex | cursor | windsurf (install agent plugins, --project for project-level)
182188
dhq mcp (start MCP server in stdio mode)
183189
```
@@ -285,19 +291,50 @@ dhq config show --resolved
285291

286292
The CLI is designed for AI agents that can run shell commands.
287293

288-
Agent skill guides are available at `.claude/SKILL.md`, `.codex/SKILL.md`, `.cursor/SKILL.md`, `.windsurf/SKILL.md`, and `docs/SKILL.md`.
294+
### Install the DeployHQ skill into your agents
295+
296+
`dhq skills install` detects the AI coding agents on your machine and installs
297+
the DeployHQ skill into each one's native format, so the agent knows how to
298+
drive `dhq`. It's also offered automatically during `dhq hello`.
289299

290300
```bash
291-
# Install agent plugin (Claude Code, Codex, Cursor, or Windsurf)
292-
dhq setup claude
301+
# Detect installed agents and show their skill status
302+
dhq skills list
303+
304+
# Install for every detected user-scope agent (Claude Code, Cursor, …)
305+
dhq skills install
306+
307+
# Install for a specific agent (use the name from `dhq skills list`)
308+
dhq skills install --agent claude-code
309+
310+
# Project-scope agents write into the current repo, so they're opt-in:
311+
dhq skills install --agent copilot
312+
```
293313

314+
Twelve agents are supported — Aider, Antigravity, Claude Code, Cline, Codex CLI,
315+
Continue.dev, Cursor, Gemini CLI, GitHub Copilot, Kiro CLI, OpenCode, and Windsurf.
316+
**User-scope** agents install into your home directory and are picked up by the
317+
bare `dhq skills install`; **project-scope** agents write into the current
318+
repository and require an explicit `--agent` flag so login never mutates a repo
319+
as a side effect.
320+
321+
`dhq setup <agent>` is a narrower alternative that installs the agent plugin for
322+
a single tool (Claude Code, Codex, Cursor, or Windsurf), with `--project` for
323+
project-level installs.
324+
325+
### Other agent helpers
326+
327+
```bash
294328
# Full command catalog with agent safety metadata
295329
dhq commands --json
296330

297331
# Agent-optimized workflow
298332
DEPLOYHQ_AGENT=my-bot dhq deploy -p my-app --json
299333
```
300334

335+
Standalone skill guides are also available at `.claude/SKILL.md`,
336+
`.codex/SKILL.md`, `.cursor/SKILL.md`, `.windsurf/SKILL.md`, and `docs/SKILL.md`.
337+
301338
### Non-Interactive Mode
302339

303340
Use `--non-interactive` to guarantee the CLI never prompts. Auto-enabled when output is piped.

internal/commands/hello.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ func newHelloCmd() *cobra.Command {
2121
return &cobra.Command{
2222
Use: "hello",
2323
Short: "Get started with DeployHQ CLI",
24-
Long: "Guided setup that walks you through login, account creation, and project configuration.",
24+
Long: "Guided setup that walks you through login, account creation, project configuration, and installing the DeployHQ skill into the user-scope AI coding agents detected on this machine.",
2525
RunE: func(cmd *cobra.Command, args []string) error {
2626
env := cliCtx.Envelope
2727

0 commit comments

Comments
 (0)