Skip to content

[docs] Update documentation for trial --dry-run flag #13874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Feb 5, 2026
Merged

[docs] Update documentation for trial --dry-run flag #13874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions docs/src/content/docs/guides/trialops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,16 @@ gh aw trial githubnext/agentics/code-review --clone-repo myorg/real-repo

## Basic Usage

### Dry-Run Mode

Preview trial operations without executing workflows or creating repositories:

```bash
gh aw trial ./my-workflow.md --dry-run
```

Dry-run mode shows what actions would be taken, including repository creation, workflow installation, and execution plans. Use this to verify trial configuration before committing to the full process.

### Single Workflow

```bash
Expand Down Expand Up @@ -205,11 +215,12 @@ cat trials/combined-results.*.json | jq '.results[] | {workflow: .workflow_name,
### Development Workflow

1. Write workflows locally in your editor
2. Test with `gh aw trial ./my-workflow.md`
3. Adjust based on trial results
4. Compare variants side-by-side
5. Validate with `--repeat`
6. Deploy to production
2. Preview with `gh aw trial ./my-workflow.md --dry-run`
3. Test with `gh aw trial ./my-workflow.md`
4. Adjust based on trial results
5. Compare variants side-by-side
6. Validate with `--repeat`
7. Deploy to production

### Testing Strategy

Expand Down
3 changes: 2 additions & 1 deletion docs/src/content/docs/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,9 +264,10 @@ gh aw trial githubnext/agentics/ci-doctor # Test remote workflow
gh aw trial ./workflow.md --use-local-secrets # Test with local API keys
gh aw trial ./workflow.md --logical-repo owner/repo # Act as different repo
gh aw trial ./workflow.md --repo owner/repo # Run directly in repository
gh aw trial ./workflow.md --dry-run # Preview actions without executing
```

**Options:** `-e`, `--engine`, `--auto-merge-prs`, `--repeat`, `--delete-host-repo-after`, `--use-local-secrets`, `--logical-repo`, `--clone-repo`, `--trigger-context`, `--repo`
**Options:** `-e`, `--engine`, `--auto-merge-prs`, `--repeat`, `--delete-host-repo-after`, `--use-local-secrets`, `--logical-repo`, `--clone-repo`, `--trigger-context`, `--repo`, `--dry-run`

#### `run`

Expand Down