Skip to content
8 changes: 8 additions & 0 deletions docs/src/content/docs/setup/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,14 @@ For `init`, `update`, and `upgrade`, use `--create-pull-request` instead.

Commands are organized by workflow lifecycle: creating, building, testing, monitoring, and managing workflows.

Use this table to choose between the similarly named setup commands:

| Command | Best fit |
|---------|----------|
| [`gh aw add-wizard`](#add-wizard) | Guided, interactive setup for an existing workflow, including prompts for engine auth and secrets |
| [`gh aw add`](#add) | Direct, non-interactive installation of an existing local, remote, or packaged workflow |
| [`gh aw new`](#new) | Scaffold a new workflow template in this repository before writing custom instructions |
Comment on lines +147 to +153

### Getting Workflows

#### `init`
Expand Down
64 changes: 64 additions & 0 deletions docs/src/content/docs/setup/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,70 @@ This will take you through an interactive process to:
> [!NOTE]
> The `.lock.yml` is the compiled GitHub Actions workflow generated from your Markdown source. GitHub Actions executes this file; regenerate it with `gh aw compile` after frontmatter changes instead of editing it by hand. See [Lock File](/gh-aw/reference/workflow-structure/#lock-file-header) for the full explanation.

For example, a short Markdown source file compiles into a longer GitHub Actions workflow. In the compiled excerpt, the top-level `permissions` map is empty because `gh-aw` moves source-level permissions onto the generated jobs that need them.

<div style={{ display: 'grid', gridTemplateColumns: 'repeat(auto-fit, minmax(18rem, 1fr))', gap: '1rem' }}>

<div>

**Markdown source (`.md`)**

```aw title=".github/workflows/issue-helper.md"
---
name: Issue Helper
on:
issues:
types: [opened]
permissions:
contents: read
issues: read
engine: copilot
---

Summarize the new issue and suggest next steps.
```

</div>

<div>

**Compiled workflow (`.lock.yml`, excerpt)**

```yaml title=".github/workflows/issue-helper.lock.yml"
# This file was automatically generated by gh-aw. DO NOT EDIT.
name: "Issue Helper"
on:
issues:
types:
- opened

permissions: {}

jobs:
activation:
runs-on: ...
permissions:
contents: read
issues: read
Comment on lines +171 to +173
steps:
- name: Generate workflow metadata
id: generate_aw_info
...
agent:
needs: activation
runs-on: ...
permissions:
contents: read
issues: read
steps:
- name: Run agent
...
```

</div>

</div>

**Configuring authentication?** Select the engine you chose above:

<Tabs>
Expand Down
Loading