### Example User Activity Request

Source: https://docs.augmentcode.com/analytics/api-reference

Demonstrates how to make a GET request to the user-activity endpoint with specified start date, end date, and page size. Includes authorization header and pipes output to jq for pretty-printing.

```bash
curl -s -X GET "https://api.augmentcode.com/analytics/v0/user-activity?start_date=2025-10-15&end_date=2025-10-20&page_size=3" \
  -H "Authorization: Bearer <your-api-token>" | jq .
```

--------------------------------

### Example Marketplace README

Source: https://docs.augmentcode.com/cli/plugins

A sample README.md for a plugin marketplace. It includes installation instructions and a list of available plugins.

```markdown
# My Plugin Marketplace

A collection of plugins for Auggie.

## Installation

\`\`\`sh
auggie plugin marketplace add yourusername/yourrepo
\`\`\`

## Available Plugins

- **hello-commands**: Simple greeting commands
- **code-guard**: Security validation hooks
```

--------------------------------

### Install Auggie CLI

Source: https://docs.augmentcode.com/context-services/mcp/quickstart-anti-gravity

Install the Auggie CLI globally using npm. This is the first step for local server setup.

```bash
npm install -g @augmentcode/auggie@latest
```

--------------------------------

### Feature Implementation Guide Command Example

Source: https://docs.augmentcode.com/cli/custom-commands-examples

Create a detailed implementation plan for a new feature. This command covers technical requirements, architecture, steps, testing, and documentation needs. Requires a feature description as an argument.

```markdown
---
description: Create implementation plan for new features
argument-hint: [feature-description]
---

Create a detailed implementation plan for: $ARGUMENTS

Include:
- Technical requirements
- Architecture considerations
- Implementation steps
- Testing approach
- Documentation needs
```

--------------------------------

### SessionStart Hook Configuration

Source: https://docs.augmentcode.com/cli/hooks

Example of configuring a hook for a session event (SessionStart) that does not require a matcher. This hook executes a setup script when a session begins.

```json
{
  "hooks": {
    "SessionStart": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "/path/to/setup-script.sh"
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Get Daily Active Users (First Page)

Source: https://docs.augmentcode.com/analytics/api-reference

Example of making an initial request to the daily active users endpoint for a specific date and page size. Ensure you replace `<your-api-token>` with your actual API token.

```bash
curl -X GET "https://api.augmentcode.com/analytics/v0/dau?date=2025-10-15&page_size=50" \
  -H "Authorization: Bearer <your-api-token>"
```

--------------------------------

### Auggie CLI for GitHub Action Assistance

Source: https://docs.augmentcode.com/cli/automation/overview

Use Auggie CLI to get help building GitHub Actions. This example prompts Auggie to assist in creating a GitHub Action.

```sh
auggie "Help me build a GitHub Action to..."
```

--------------------------------

### Documentation Generator Command Example

Source: https://docs.augmentcode.com/cli/custom-commands-examples

Generate comprehensive documentation for a file or component, including overview, API reference, usage examples, configuration, error handling, and dependencies. Requires a file path as an argument.

```markdown
---
description: Generate comprehensive documentation
argument-hint: [file-path]
---

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.
```

--------------------------------

### Start Auggie CLI in Interactive Mode

Source: https://docs.augmentcode.com/cli/config

To begin using the configuration wizard, first start Auggie CLI in its interactive mode. Once running, you can access the wizard using a specific command.

```sh
# Start Auggie in interactive mode
auggie

# Then type the slash command
/config
```

--------------------------------

### Quick Start with Auggie Python SDK

Source: https://docs.augmentcode.com/cli/sdk

Initialize the Auggie agent and run a prompt request in Python, specifying the return type.

```python
from auggie_sdk import Auggie

agent = Auggie(model="sonnet4.5")
result = agent.run("What is 2 + 2?", return_type=int)
print(result)  # 4
```

--------------------------------

### Skill Directory Structure Example

Source: https://docs.augmentcode.com/cli/skills

Illustrates how skill subdirectories should be organized within the .augment/skills/ directory.

```directory
.augment/skills/
  ├── python-testing/
  │   └── SKILL.md
  ├── api-design/
  │   └── SKILL.md
  └── database-migrations/
      └── SKILL.md
```

--------------------------------

### Manage Auggie Plugins

Source: https://docs.augmentcode.com/cli/reference

Commands for listing and installing plugins from installed marketplaces. Plugins can be enabled or disabled during installation.

```sh
auggie plugin list
```

```sh
auggie plugin install <plugin-id>
```

```sh
auggie plugin install <plugin-id> --disable
```

--------------------------------

### Get Daily Active Users (Next Page)

Source: https://docs.augmentcode.com/analytics/api-reference

Example of fetching the next page of results for the daily active users endpoint using the `cursor` from the previous response's pagination information. This is part of the pagination process.

```bash
curl -X GET "https://api.augmentcode.com/analytics/v0/dau?date=2025-10-15&page_size=50&cursor=eyJsYXN0X2lkIjoidXNlcjUwIn0=" \
  -H "Authorization: Bearer <your-api-token>"
```

--------------------------------

### Example SKILL.md File Structure

Source: https://docs.augmentcode.com/cli/skills

Demonstrates the basic structure of a SKILL.md file, including YAML frontmatter and markdown content.

```markdown
---
name: python-testing
description: Best practices for writing and running Python tests with pytest
---

# Python Testing Skill

This skill provides guidance on writing effective Python tests.
```

--------------------------------

### Make an API Request with Authentication

Source: https://docs.augmentcode.com/analytics/analytics-api

This example shows how to make a GET request to the Daily Active Users Count endpoint using curl. Ensure you replace '<your-api-token>' with your actual API token obtained from a service account.

```bash
curl -X GET "https://api.augmentcode.com/analytics/v0/dau-count" \
  -H "Authorization: Bearer <your-api-token>"
```

--------------------------------

### Install Auggie SDK for TypeScript

Source: https://docs.augmentcode.com/cli/sdk

Install the Auggie SDK for Node.js and TypeScript projects using npm.

```sh
npm install @augmentcode/auggie-sdk
```

--------------------------------

### Daily Usage Response Example

Source: https://docs.augmentcode.com/analytics/api-reference

This is an example of the JSON response received when querying the daily usage endpoint. It includes detailed metrics for each day within the requested range.

```json
{
  "daily_usage": [
    {
      "date": "2025-10-15",
      "metrics": {
        "total_modified_lines_of_code": 1250,
        "total_messages": 340,
        "total_tool_calls": 890,
        "completions_count": 1500,
        "completions_accepted": 1120,
        "completions_lines_of_code": 980,
        "chat_messages": 85,
        "remote_agent_messages": 0,
        "remote_agent_lines_of_code": 0,
        "ide_agent_messages": 150,
        "ide_agent_lines_of_code": 95,
        "cli_agent_interactive_messages": 40,
        "cli_agent_interactive_lines_of_code": 35,
        "cli_agent_non_interactive_messages": 20,
        "cli_agent_non_interactive_lines_of_code": 20
      }
    }
  ],
  "metadata": {
    "effective_start_date": "2025-10-15",
    "effective_end_date": "2025-10-20",
    "generated_at": "2025-10-21T10:30:00Z",
    "total_days": 1
  }
}
```

--------------------------------

### Install Auggie CLI

Source: https://docs.augmentcode.com/cli/automation

Install the Auggie CLI globally using npm. Ensure Node.js version 20 or later is available.

```bash
npm install -g @augmentcode/auggie

```

--------------------------------

### Prompt Enhancement Example: After

Source: https://docs.augmentcode.com/cli/interactive/prompt-enhancer

Shows an example of an enhanced prompt, including specific file references, action items, and context, generated by the prompt enhancer.

```plaintext
Fix the authentication bug in the login flow. Please:

1. Review the current login implementation in `src/auth/login.ts`
2. Check for issues with token validation and session management
3. Examine error handling in the authentication middleware
4. Look at recent changes to the user authentication flow
5. Test the fix with both valid and invalid credentials
6. Ensure the fix follows our existing error handling patterns

Context: This appears to be related to the recent changes in the authentication system. Please maintain consistency with our existing auth patterns and ensure proper error messages are returned to the user.
```

--------------------------------

### Subagent Configuration Example

Source: https://docs.augmentcode.com/cli/subagents

Example of a subagent configuration file in markdown format with YAML frontmatter. This defines a 'code-review' agent with specific model, color, and prompt instructions.

```markdown
---
name: code-review
description: Code review agent
model: sonnet4.5
color: purple
---

You are an agentic code-review AI assistant with access to the developer's codebase through Augment's deep codebase context engine and integrations. You are conducting a comprehensive code review for the staged changes in the current working directory.

## Review Areas to focus on:

- **Potential Bugs**: Identify bugs, logic errors, edge cases, crash-causing problems.
- **Security Concerns**: Look for potential vulnerabilities, input validation, authentication issues ONLY if the code is security-sensitive
- **Documentation**: Report comments or documentation that is incorrect or inconsistent with the code.
- **API contract violations**
- **Database and schema errors**
- **High Value Typos**: typos that affect correctness, UX-strings, etc.

```

--------------------------------

### Execute Custom Commands

Source: https://docs.augmentcode.com/cli/reference

Examples of executing custom commands. These commands can be defined in local or global directories.

```sh
# Execute a custom deployment command
auggie command deploy-staging

# Execute a code review command
auggie command security-review

# List available commands
auggie command list
```

--------------------------------

### Activate Task Manager

Source: https://docs.augmentcode.com/cli/interactive/task-management

Start Auggie in interactive mode and use the /task command to open the task manager interface.

```bash
auggie

/task
```

--------------------------------

### Example SessionStart Event

Source: https://docs.augmentcode.com/cli/hooks

A typical SessionStart event payload. This event signifies the beginning of a user session and contains base fields.

```json
{
  "hook_event_name": "SessionStart",
  "conversation_id": "conv-xyz789",
  "workspace_roots": ["/Users/username/project"]
}
```

--------------------------------

### Example Directory Structure for Hierarchical Rules

Source: https://docs.augmentcode.com/cli/rules

Illustrates how AGENTS.md files in different directories contribute to hierarchical rule discovery.

```plaintext
my-project/
  AGENTS.md                  <-
  src/
    AGENTS.md                <-
    frontend/
      AGENTS.md                <-
      App.tsx
    backend/
      AGENTS.md                <-
      server.ts
  tests/
    AGENTS.md                <-
```

--------------------------------

### Inject Context at Session Start (Bash)

Source: https://docs.augmentcode.com/cli/hooks

Write to stdout during SessionStart to inject context for the agent, such as loading issues from an API.

```bash
#!/usr/bin/env bash

# Load current issues from issue tracker
ISSUES=$(curl -s https://api.example.com/issues)

# Output to stdout - this will be injected as context for the agent
echo "Current open issues:"
echo "$ISSUES"

exit 0
```

--------------------------------

### Example Auggie settings.json

Source: https://docs.augmentcode.com/cli/config

Demonstrates a typical configuration structure for Auggie settings, including shell, startup script, and various feature toggles.

```json
{
  "shell": "zsh",
  "startupScript": "source ~/.augment/startup.sh",
  "enableChatInputCompletions": true,
  "autoUpdate": true,
  "notificationMode": "desktop_notification",
  "autoUpdateMarketplaces": true,
  "theme": "default-dark"
}
```

--------------------------------

### TypeScript Function Signature Example

Source: https://docs.augmentcode.com/jetbrains/using-augment/completions

An example of a TypeScript function signature for `getUser`. This is a starting point for code completion.

```typescript
function getUser(): Promise<User>;
```

--------------------------------

### Provide Instruction from File

Source: https://docs.augmentcode.com/cli/reference

Load the initial instruction from a specified file using the `--instruction-file` flag.

```bash
auggie --instruction-file /path/to/file.txt
```

--------------------------------

### GET /analytics/v0/dau-count Example Request

Source: https://docs.augmentcode.com/analytics/api-reference

Example of how to request daily active user counts for a specific date range using curl. Ensure to replace `<your-api-token>` with your actual API token.

```bash
curl -X GET "https://api.augmentcode.com/analytics/v0/dau-count?start_date=2025-10-15&end_date=2025-10-20" \
  -H "Authorization: Bearer <your-api-token>"
```

--------------------------------

### GET /analytics/v0/dau-count Example Response

Source: https://docs.augmentcode.com/analytics/api-reference

Example JSON response for the DAU count endpoint, showing daily user counts and metadata. The response includes the effective date range and generation timestamp.

```json
{
  "daily_active_user_counts": [
    {"date": "2025-10-15", "user_count": 100},
    {"date": "2025-10-16", "user_count": 120},
    {"date": "2025-10-17", "user_count": 95},
    {"date": "2025-10-18", "user_count": 140},
    {"date": "2025-10-19", "user_count": 88},
    {"date": "2025-10-20", "user_count": 110}
  ],
  "metadata": {
    "effective_start_date": "2025-10-15",
    "effective_end_date": "2025-10-20",
    "generated_at": "2025-10-21T10:30:00Z",
    "total_days": 6
  }
}
```

--------------------------------

### Start Auggie CLI

Source: https://docs.augmentcode.com/cli/overview

Initiate the Auggie CLI. You can provide an optional initial prompt. Use `--print` to output the response directly to stdout, which is useful for automation.

```sh
auggie "optional initial prompt"
```

--------------------------------

### Start Auggie with an Initial Instruction

Source: https://docs.augmentcode.com/cli/interactive

Provide an initial instruction as a string argument to `auggie` to begin a specific task immediately upon startup.

```sh
auggie "Look at my open issues and prioritize the highest impact ones for me"
```

--------------------------------

### Full Configuration

Source: https://docs.augmentcode.com/cli/sdk-typescript

Initializes the Auggie client with a comprehensive set of configuration options, including executable path, workspace, model, API key, custom tools, and more. It then demonstrates sending a prompt using the configured client.

```APIDOC
## Full Configuration

Initializes the Auggie client with a comprehensive set of configuration options, including executable path, workspace, model, API key, custom tools, and more. It then demonstrates sending a prompt using the configured client.

### Method

```typescript
import { Auggie } from "@augmentcode/auggie-sdk";

const client = await Auggie.create({
  // Path to Auggie executable (default: "auggie")
  auggiePath: "/path/to/auggie",

  // Working directory for the Auggie process (default: process.cwd())
  workspaceRoot: "/path/to/workspace",

  // Eg: "haiku4.5" | "gpt-5" | "sonnet4.5" | "sonnet4"
  model: "sonnet4.5",

  // Allow codebase indexing (default: true)
  allowIndexing: true,

  // API key for authentication (optional)
  apiKey: "your-api-key",

  // API URL (optional)
  apiUrl: "https://your-tenant.api.augmentcode.com",

  // Custom tools to provide to Auggie (optional)
  tools: {
    // Your custom tools here
  },

  // Rule file paths (optional)
  rules: ["/path/to/rules.md"],

  // Additional CLI arguments to pass to the Auggie process (optional)
  cliArgs: ["--quiet", "--max-turns=10"]
});

// Use the client
const response = await client.prompt("Your question here");
console.log(response);

await client.close();
```
```

--------------------------------

### GET /analytics/v0/dau-count

Source: https://docs.augmentcode.com/analytics/api-reference

Returns daily active user counts over a date range. Supports specifying start and end dates, with default behavior for missing dates. Constraints include a maximum date range and historical lookback.

```APIDOC
## GET /analytics/v0/dau-count

### Description
Returns daily active user counts over a date range. Supports specifying start and end dates, with default behavior for missing dates. Constraints include a maximum date range and historical lookback.

### Method
GET

### Endpoint
/analytics/v0/dau-count

### Parameters
#### Query Parameters
- **start_date** (string) - Optional - Start date in `YYYY-MM-DD` format (UTC)
- **end_date** (string) - Optional - End date in `YYYY-MM-DD` format (UTC)

### Date Range Behavior
- Neither date provided: Returns last 7 days ending at yesterday (UTC)
- Only `start_date` provided: Returns 7 days starting from `start_date`, capped at yesterday
- Only `end_date` provided: Returns 7 days ending at `end_date`
- Both dates provided: Returns the specified inclusive range

### Constraints
- Maximum date range: 90 days
- Maximum historical lookback: 2 years
- Today and future dates: Not allowed (data available at ~02:00 UTC next day)
- Timezone: All dates interpreted as UTC

### Request Example
```bash
curl -X GET "https://api.augmentcode.com/analytics/v0/dau-count?start_date=2025-10-15&end_date=2025-10-20" \
  -H "Authorization: Bearer <your-api-token>"
```

### Response
#### Success Response (200)
- **daily_active_user_counts** (array) - Array of daily user counts, one per day
  - **daily_active_user_counts[].date** (string) - Calendar date (`YYYY-MM-DD`)
  - **daily_active_user_counts[].user_count** (integer) - Number of unique active users
- **metadata.effective_start_date** (string) - Actual start date used (UTC, after defaults/clamping)
- **metadata.effective_end_date** (string) - Actual end date used (UTC, after defaults/clamping)
- **metadata.generated_at** (string) - Response generation timestamp (ISO 8601)
- **metadata.total_days** (integer) - Number of days in the range

#### Response Example
```json
{
  "daily_active_user_counts": [
    {"date": "2025-10-15", "user_count": 100},
    {"date": "2025-10-16", "user_count": 120},
    {"date": "2025-10-17", "user_count": 95},
    {"date": "2025-10-18", "user_count": 140},
    {"date": "2025-10-19", "user_count": 88},
    {"date": "2025-10-20", "user_count": 110}
  ],
  "metadata": {
    "effective_start_date": "2025-10-15",
    "effective_end_date": "2025-10-20",
    "generated_at": "2025-10-21T10:30:00Z",
    "total_days": 6
  }
}
```
```

--------------------------------

### MCP Server with Pre-indexed and Auto-discovered Workspaces

Source: https://docs.augmentcode.com/cli/reference

Combine `--mcp-auto-workspace` with `-w` to pre-index a primary workspace at startup while still allowing dynamic discovery of additional workspaces. This balances initial indexing time with flexibility.

```bash
auggie --mcp --mcp-auto-workspace -w /path/to/primary/project
```

--------------------------------

### Install Auggie SDK for Python

Source: https://docs.augmentcode.com/cli/sdk

Install the Auggie SDK for Python projects using pip.

```sh
pip install auggie-sdk
```

--------------------------------

### Provide Initial Instruction

Source: https://docs.augmentcode.com/cli/reference

Specify an initial instruction for interactive mode or for a single run.

```bash
auggie "Fix the typescript errors"
```

```bash
auggie --instruction "Fix the errors"
```

--------------------------------

### Define a Custom Command with Arguments and Frontmatter

Source: https://docs.augmentcode.com/cli/custom-commands

This example defines a custom command with frontmatter for metadata like description and argument hints, and shows how to use it with an argument.

```markdown
---
description: Deploy the application to staging with health checks
argument-hint: [branch-name]
model: gpt-4o
---

Deploy the application to the staging environment:

1. Run all tests to ensure code quality
2. Build the application for production
3. Deploy to staging server
4. Run health checks to verify deployment
5. Send notification to team channel
```

--------------------------------

### View Installed Plugins Command

Source: https://docs.augmentcode.com/cli/plugins

Command to list all installed plugins and their details within the Auggie environment.

```sh
# View what's included
/plugins
```

--------------------------------

### Create Workspace and User Commands

Source: https://docs.augmentcode.com/using-augment/custom-commands

Demonstrates how to create markdown files for workspace-specific and user-specific commands using bash.

```bash
# Workspace command (shared with your team)
mkdir -p .augment/commands
echo "Review this code for security vulnerabilities and suggest fixes." > .augment/commands/security-review.md

# User command (available across all projects)
mkdir -p ~/.augment/commands
echo "Analyze this code for performance issues:" > ~/.augment/commands/optimize.md
```

--------------------------------

### Example Stop Event

Source: https://docs.augmentcode.com/cli/hooks

An example of a Stop event, which includes the reason the agent terminated. The `agent_stop_cause` field specifies the termination reason.

```json
{
  "hook_event_name": "Stop",
  "conversation_id": "conv-xyz789",
  "workspace_roots": ["/Users/username/project"],
  "agent_stop_cause": "end_turn"
}
```

--------------------------------

### Clone Augment.vim for Neovim (Manual)

Source: https://docs.augmentcode.com/vim/setup-augment/install-vim-neovim

Manually install Augment for Neovim by cloning the repository into the specified configuration directory. Ensure you have Git installed.

```sh
git clone https://github.com/augmentcode/augment.vim.git ~/.config/nvim/pack/augment/start/augment.vim
```

--------------------------------

### Example Rules File Structure

Source: https://docs.augmentcode.com/cli/rules

This Markdown structure outlines recommended sections for defining project guidelines, including code style, architecture, testing, and dependencies. It helps Auggie understand project conventions and standards.

```markdown
# Project Guidelines

## Code Style
- Use TypeScript for all new JavaScript files
- Follow the existing naming conventions in the codebase
- Add JSDoc comments for all public functions and classes

## Architecture
- Follow the MVC pattern established in the codebase
- Place business logic in service classes
- Keep controllers thin and focused on request/response handling

## Testing
- Write unit tests for all new functions
- Maintain test coverage above 80%
- Use Jest for testing framework

## Dependencies
- Prefer built-in Node.js modules when possible
- Use npm for package management
- Pin exact versions in package.json for production dependencies
```

--------------------------------

### Example Validation Script

Source: https://docs.augmentcode.com/cli/permissions

An example bash script that reads a JSON payload from stdin, extracts command details, and exits with 0 to allow or 1 to deny.

```bash
#!/bin/bash
# Read JSON payload from stdin
payload=$(cat)

# Extract command using jq
command=$(echo "$payload" | jq -r '.details.command // empty')

# Deny dangerous commands
if [[ "$command" == *"rm -rf"* ]] || [[ "$command" == *"sudo"* ]]; then
  echo "Dangerous command blocked: $command"
  exit 1
fi

# Allow all other commands
exit 0
```

--------------------------------

### Quick Start with Auggie TypeScript SDK

Source: https://docs.augmentcode.com/cli/sdk

Initialize the Auggie client and make a prompt request in TypeScript. Ensure the client is closed after use.

```typescript
import { Auggie } from "@augmentcode/auggie-sdk";

const client = await Auggie.create({ model: "sonnet4.5" });
const response = await client.prompt("What files are in the current directory?");
console.log(response);
await client.close();
```

--------------------------------

### Load Context at Session Start (Python)

Source: https://docs.augmentcode.com/cli/hooks-examples

Injects development context, such as recent git commits and branch info, when a session starts using a Python script.

```python
#!/usr/bin/env python3
import sys
import subprocess

# Load recent git commits
print("Recent commits:")
result = subprocess.run(['git', 'log', '--oneline', '-5'],
                       capture_output=True, text=True)
print(result.stdout)

# Load current branch info
print("")
print("Current branch:", end=" ")
result = subprocess.run(['git', 'branch', '--show-current'],
                       capture_output=True, text=True)
print(result.stdout.strip())

sys.exit(0)
```

```json
{
  "hooks": {
    "SessionStart": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "/etc/augment/hooks/load-context.sh",
            "timeout": 10000
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Initialize Auggie Client (Basic)

Source: https://docs.augmentcode.com/cli/sdk-typescript

Initialize the Auggie client with a specified model and send a prompt. This demonstrates the simplest way to start interacting with the SDK.

```typescript
import { Auggie } from "@augmentcode/auggie-sdk";

// Simple initialization
const client = await Auggie.create({
  model: "sonnet4.5"
});

// Send a prompt
const response = await client.prompt("What files are in the current directory?");
console.log(response);

// Close the connection
await client.close();
```

--------------------------------

### Load Context at Session Start (Bash)

Source: https://docs.augmentcode.com/cli/hooks-examples

Injects development context, such as recent git commits and branch info, when a session starts using a bash script.

```bash
#!/usr/bin/env bash

# Load recent git commits
echo "Recent commits:"
git log --oneline -5

# Load current branch info
echo ""
echo "Current branch: $(git branch --show-current)"

# Load open issues (example)
echo ""
echo "Open issues:"
# curl -s https://api.example.com/issues | jq -r '.[] | "- \(.title)"'

exit 0
```

--------------------------------

### SKILL.md File Format Example

Source: https://docs.augmentcode.com/jetbrains/using-augment/skills

Demonstrates the structure of a SKILL.md file, including YAML frontmatter for metadata and markdown content for instructions. The frontmatter requires 'name' and 'description' fields.

```markdown
---
name: deploy-guide
description: Step-by-step deployment procedures for our production infrastructure
---

# Deployment Guide

## Pre-deployment Checklist
1. Run all tests with `npm test`
2. Verify environment variables are set
3. Check database migrations are up to date

## Deploying to Production
...
```

--------------------------------

### Analytics API Error Response Example

Source: https://docs.augmentcode.com/analytics/api-reference

This is an example of a generic error response from the API, indicating an invalid request parameter such as a date range exceeding the allowed limit.

```json
{
  "error": {
    "code": "InvalidArgument",
    "message": "end_date cannot be later than yesterday (UTC)"
  }
}
```

--------------------------------

### Auggie CLI with Instruction File

Source: https://docs.augmentcode.com/cli/automation

Provide instructions from a file and pipe data through stdin for processing. Use `--compact` for concise output.

```bash
# Provide the instruction from a file with compact print-mode output
auggie --print --compact --instruction-file /path/to/instruction.md < build.log

```

--------------------------------

### List All Available Commands

Source: https://docs.augmentcode.com/cli/custom-commands

Lists all available commands, including built-in and custom ones. Custom commands are displayed with their descriptions.

```bash
auggie command list
```

--------------------------------

### Skill Directory Structure Example

Source: https://docs.augmentcode.com/jetbrains/using-augment/skills

Illustrates the standard directory structure for organizing skills within an Augment project. Each skill resides in its own named directory containing a SKILL.md file.

```bash
.augment/skills/
  ├── python-testing/
  │   └── SKILL.md
  ├── api-design/
  │   └── SKILL.md
  └── deploy-guide/
      └── SKILL.md
```

--------------------------------

### Recommend Marketplaces in Project Settings

Source: https://docs.augmentcode.com/cli/plugins

Configure recommended plugin marketplaces for a project by adding the 'recommendedMarketplaces' key to the .augment/settings.json file.

```json
{
  "recommendedMarketplaces": [
    "yourorg/team-plugins",
    "yourorg/security-tools"
  ]
}
```

--------------------------------

### GET Credit Usage (Next Page)

Source: https://docs.augmentcode.com/analytics/api-reference

Make a GET request to retrieve the next page of credit usage data. Use the `cursor` parameter from the previous response's `pagination.next_cursor` value and include your API token.

```bash
curl -X GET "https://api.augmentcode.com/analytics/v0/credit-usage-by-user?start_date=2026-03-01&end_date=2026-03-07&by_date=true&by_model=true&page_size=2&cursor=eyJ1IjoiMDAwMSIsImQiOiIyMDI2LTAzLTAxIiwibSI6ImdwdC00byJ9" \
  -H "Authorization: Bearer <your-api-token>"
```

--------------------------------

### Add Stdio MCP Server with Command and Args

Source: https://docs.augmentcode.com/cli/integrations

Adds a stdio-based MCP server using `auggie mcp add`. This example specifies the command to execute and its arguments, including environment variables.

```bash
auggie mcp add context7 \
  --command npx \
  --args "-y @upstash/context7-mcp@latest" \
  --env CONTEXT7_API_KEY=your_key
```

```bash
# Compressed syntax
auggie mcp add context7 -- npx -y @upstash/context7-mcp
```

--------------------------------

### GET Credit Usage (With Dimensions and Pagination)

Source: https://docs.augmentcode.com/analytics/api-reference

Make a GET request to retrieve credit usage data with breakdowns by date and model, specifying a date range and page size. Include your API token in the Authorization header.

```bash
curl -X GET "https://api.augmentcode.com/analytics/v0/credit-usage-by-user?start_date=2026-03-01&end_date=2026-03-07&by_date=true&by_model=true&page_size=2" \
  -H "Authorization: Bearer <your-api-token>"
```

--------------------------------

### Basic Auggie Initialization and Run

Source: https://docs.augmentcode.com/cli/sdk-python

Initialize the Auggie agent with a model and run a simple task, specifying the return type.

```python
from auggie_sdk import Auggie

# Simple initialization
agent = Auggie(model="sonnet4.5")

# Run a task
result = agent.run("What is 2 + 2?", return_type=int)
print(result)  # 4
```