> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentuse.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Deploy your first autonomous agent in 5 minutes

## Installation

```bash theme={"system"}
pnpm install -g agentuse
```

<Info>
  See [Installation Guide](/installation) for npm, bunx, Docker, and development setup options.
</Info>

## Authentication

```bash theme={"system"}
agentuse auth login
```

<Info>
  See [Model Configuration](/guides/model-configuration) for OAuth setup, API keys, and environment variable configuration.
</Info>

## Supported Models

AgentUse supports multiple AI providers with the format `provider:model-name`. Examples:

```bash theme={"system"}
anthropic:claude-sonnet-5
openai:gpt-5.5
openrouter:minimax/minimax-m3
opencode-go:kimi-k2.7-code
bedrock:us.anthropic.claude-sonnet-4-5-20250929-v1:0
```

<Tip>
  Any model available from Anthropic, OpenAI, OpenRouter, OpenCode Go, or Amazon Bedrock can be used. You can also specify custom API keys: `anthropic:claude-sonnet-5:CUSTOM_API_KEY`
</Tip>

## Your First Agent

Create `hello.agentuse`:

```markdown theme={"system"}
---
model: anthropic:claude-haiku-4-5
description: "Simple greeting agent that welcomes users"
---

Greet the user.
```

Run it:

```bash theme={"system"}
agentuse run hello.agentuse

# Or run with additional instructions
agentuse run hello.agentuse "speak like a pirate"

# Run with options
agentuse run hello.agentuse --verbose
agentuse run hello.agentuse --quiet
agentuse run hello.agentuse --no-tty
agentuse run hello.agentuse --timeout 600

# Override the model at runtime
agentuse run hello.agentuse --model openai:gpt-5.4-mini
agentuse run hello.agentuse -m anthropic:claude-sonnet-5
```

## File System Agent

Create `project-analyzer.agentuse`:

```markdown theme={"system"}
---
model: anthropic:claude-haiku-4-5
description: "Analyzes project structure and identifies key components"
mcpServers:
  filesystem:
    command: "npx"
    args: ["-y", "@modelcontextprotocol/server-filesystem", "."]
---

You are a code analyzer. When asked about a project:
1. List the main files and folders
2. Identify the project type (Node.js, Python, etc.)
3. Summarize what the project does based on README or package.json
```

Run it:

```bash theme={"system"}
agentuse run project-analyzer.agentuse
```

<Info>
  See [Agent Syntax - MCP Servers](/reference/agent-syntax#mcp-servers) for HTTP servers, environment variables, and tool restrictions.
</Info>

## Model Override

Override the model at runtime without editing agent files:

```bash theme={"system"}
agentuse run analyzer.agentuse --model anthropic:claude-sonnet-5
agentuse run analyzer.agentuse -m openai:gpt-5.4-mini
```

<Tip>
  See [CLI Commands - Model Override](/reference/cli-commands#model-override) for format details, environment-specific keys, and sub-agent inheritance behavior.
</Tip>

## Sub-agents Support

AgentUse supports calling other agents as sub-agents:

```markdown theme={"system"}
---
model: anthropic:claude-haiku-4-5
description: "Orchestrates tasks by delegating to specialized sub-agents"
subagents:
  - path: "./helper-agent.agentuse"
    name: "helper"
    maxSteps: 50
---

You can call the helper agent using the sub-agent tools.
```

## Remote Agents

You can run agents directly from HTTPS URLs:

```bash theme={"system"}
# Run from trusted sources (agentuse.io) without prompts
agentuse run https://agentuse.io/hello.agentuse

# Other URLs will prompt for confirmation
agentuse run https://example.com/path/to/agent.agentuse

# Preview the agent content first
# Choose 'p' when prompted to preview before execution
```

<Warning>
  Only HTTPS URLs with `.agentuse` extensions are supported for security. Always review remote agents before execution.
</Warning>

## Environment Variables

Configure API keys and behavior via environment variables or `.env` files:

```bash theme={"system"}
export ANTHROPIC_API_KEY="sk-ant-..."
export OPENAI_API_KEY="sk-proj-..."
```

<Info>
  See [Environment Variables Reference](/reference/environment-variables) for all configuration options including custom API key suffixes, behavior control, and MCP server settings.
</Info>

## Schedule Your Agent

Add a `schedule` to run agents automatically:

```markdown theme={"system"}
---
model: anthropic:claude-sonnet-5
schedule: "1h"    # Or cron: "0 * * * *"
---

Check system status and send a summary report.
```

Start the server to enable scheduling:

```bash theme={"system"}
agentuse serve
```

<Info>
  See [Scheduled Agents Guide](/guides/schedule) for cron expressions, intervals, and best practices.
</Info>

## What's Next?

<CardGroup cols={2}>
  <Card title="Creating Agents" icon="file-pen" href="/guides/creating-agents">
    Learn agent syntax
  </Card>

  <Card title="Examples" icon="lightbulb" href="https://github.com/agentuse/agentuse/tree/main/templates/agents">
    See more examples
  </Card>
</CardGroup>