Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 1 addition & 15 deletions .augment/commands/code-review.md
Original file line number Diff line number Diff line change
@@ -1,15 +1 @@
---
description: Perform a comprehensive code review
argument-hint: [file-path]
model: gpt5
---

Please perform a comprehensive code review of the specified file or current changes, focusing on:

1. Code Quality: Check for readability, maintainability, and adherence to best practices
2. Security: Look for potential security vulnerabilities
3. Performance: Identify potential performance issues
4. Testing: Suggest areas that need test coverage
5. Documentation: Check if code is properly documented

$ARGUMENTS
404: Not Found
55 changes: 0 additions & 55 deletions .github/workflows/format-check.yml

This file was deleted.

46 changes: 46 additions & 0 deletions examples/commands/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Augment Commands

Pre-built command templates for common development tasks. Use directly or customize for your needs.

## Installation

### Install All Commands
```bash
mkdir -p ~/.augment/commands
cd ~/.augment/commands
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/code-review.md
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/documentation.md
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/tests.md
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/bug-fix.md
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/performance-optimization.md
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/security-review.md
```

### Install Specific Commands
```bash
mkdir -p ~/.augment/commands
cd ~/.augment/commands
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/code-review.md
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/documentation.md
```

## Usage

```bash
auggie "/code-review src/main.py"
auggie "/documentation src/utils.py"
auggie "/tests src/api/"
```

## Available Commands

- `code-review.md` - Code quality checks
- `documentation.md` - Documentation generation
- `tests.md` - Test coverage
- `bug-fix.md` - Debugging assistance
- `performance-optimization.md` - Performance improvements
- `security-review.md` - Security analysis

## Customization

Edit the `.md` files to modify prompts, change models, or adjust behavior for your needs.
14 changes: 14 additions & 0 deletions examples/commands/bug-fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
description: Generate a structured bug fix approach
argument-hint: [bug-description]
model: gpt5
---

Help me fix this bug: $ARGUMENTS

Please provide:

1. Root cause analysis
2. Step-by-step fix approach
3. Testing strategy
4. Prevention measures for similar issues
15 changes: 15 additions & 0 deletions examples/commands/code-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
description: Perform a comprehensive code review
argument-hint: [file-path]
model: gpt5
---

Please perform a comprehensive code review of the specified file or current changes, focusing on:

1. Code Quality: Check for readability, maintainability, and adherence to best practices
2. Security: Look for potential security vulnerabilities
3. Performance: Identify potential performance issues
4. Testing: Suggest areas that need test coverage
5. Documentation: Check if code is properly documented

$ARGUMENTS
18 changes: 18 additions & 0 deletions examples/commands/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
description: Generate comprehensive documentation
argument-hint: [file-or-component]
model: gpt5
---

Generate documentation for: $ARGUMENTS

Include:

1. Overview and purpose
2. API reference with parameters and return values
3. Usage examples with code snippets
4. Configuration options if applicable
5. Error handling and troubleshooting
6. Dependencies and requirements

Format as clear, structured markdown.
18 changes: 18 additions & 0 deletions examples/commands/performance-optimization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
description: Analyze and optimize code performance
argument-hint: [file-path]
model: gpt5
---

Analyze the performance of: $ARGUMENTS

Please examine:

1. Algorithm complexity and efficiency
2. Memory usage patterns
3. Database queries and optimization opportunities
4. Caching strategies
5. Network requests and bundling
6. Rendering performance (for frontend code)

Suggest specific optimizations with expected impact.
18 changes: 18 additions & 0 deletions examples/commands/security-review.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
description: Perform security analysis on code
argument-hint: [file-path]
model: gpt5
---

Perform a security review of: $ARGUMENTS

Focus on:

1. Input validation and sanitization
2. Authentication and authorization checks
3. Data exposure and privacy concerns
4. Injection vulnerabilities (SQL, XSS, etc.)
5. Cryptographic implementations
6. Dependencies with known vulnerabilities

Provide specific recommendations for any issues found.
18 changes: 18 additions & 0 deletions examples/commands/tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
description: Generate comprehensive test cases
argument-hint: [file-or-module]
model: gpt5
---

Generate test cases for: $ARGUMENTS

Create tests covering:

1. Happy path scenarios
2. Edge cases and boundary conditions
3. Error handling and exceptions
4. Integration points with other components
5. Performance considerations
6. Security edge cases

Use appropriate testing framework conventions and include setup/teardown as needed.
57 changes: 57 additions & 0 deletions examples/workflows/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# GitHub Workflows

GitHub Actions workflows for integrating Augment's AI-powered code review and PR descriptions.

## Installation

### Install All Workflows
```bash
mkdir -p .github/workflows
cd .github/workflows
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/describe-pr.yml
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/pr-review.yml
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/on-demand-description.yml
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/on-demand-review.yml
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/release.yml
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/test-action.yml
git add .github/workflows/
git commit -m "Add Augment AI workflows"
git push
```

### Install Specific Workflows
```bash
mkdir -p .github/workflows
cd .github/workflows
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/describe-pr.yml
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/pr-review.yml
git add .github/workflows/
git commit -m "Add Augment AI workflows"
git push
```

## Setup

**Required Secret**: Add `AUGMENT_SESSION_AUTH` to your repository:
1. Go to Settings → Secrets and variables → Actions
2. Click "New repository secret"
3. Name: `AUGMENT_SESSION_AUTH`
4. Value: Your Augment session authentication token

## Available Workflows

**Automatic**:
- `describe-pr.yml` - Auto-generates PR descriptions
- `pr-review.yml` - Auto-reviews new PRs

**On-Demand** (triggered by labels):
- `on-demand-description.yml` - Add `augment_describe` label
- `on-demand-review.yml` - Add `augment_review` label

**Other**:
- `release.yml` - Automated release notes
- `test-action.yml` - Manual testing

## Customization

Edit the `.yml` files to modify triggers, parameters, or add additional steps.
23 changes: 23 additions & 0 deletions examples/workflows/describe-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Basic PR Description Generation
# Automatically generates AI-powered descriptions for new pull requests

name: Auto-describe PRs
on:
pull_request:
types: [opened]

jobs:
describe:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- name: Generate PR Description
uses: augmentcode/describe-pr@v0
with:
augment_session_auth: ${{ secrets.AUGMENT_SESSION_AUTH }}
github_token: ${{ secrets.GITHUB_TOKEN }}
pull_number: ${{ github.event.pull_request.number }}
repo_name: ${{ github.repository }}

49 changes: 49 additions & 0 deletions examples/workflows/on-demand-description.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# On-Demand PR Description
# Generates descriptions when the "augment_describe" label is added to a PR

name: On-Demand PR Description
on:
pull_request:
types: [labeled]

jobs:
describe:
# Only run when the specific label is added
if: github.event.label.name == 'augment_describe'
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- name: Generate PR Description
uses: augmentcode/describe-pr@v0
with:
augment_session_auth: ${{ secrets.AUGMENT_SESSION_AUTH }}
github_token: ${{ secrets.GITHUB_TOKEN }}
pull_number: ${{ github.event.pull_request.number }}
repo_name: ${{ github.repository }}

- name: Remove trigger label
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
with:
script: |
// Remove the trigger label after processing
await github.rest.issues.removeLabel({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
name: 'augment_describe'
});

- name: Add completion label
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
with:
script: |
// Add a label to indicate the description was generated
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
labels: ['auto-described']
});

Loading