---
sidebar_label: "Quick Start"
sidebar_custom_props:
  section: "Templates"
  section_position: 1
---

{/*

Quick Start pages help users achieve their first success as quickly as possible. Focus on 
the minimal steps needed to get started, avoiding deep explanations. Use numbered steps and 
verification checkpoints. Link to comprehensive guides for users who want to learn more.

*/}

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Quick Start Template

Get up and running in just a few minutes with this step-by-step guide.

## Prerequisites

Before you begin, ensure you have:

- Basic familiarity with the command line
- An active internet connection
- Administrator/sudo access (for installation)

## Installation

Choose your platform and follow the installation command:

<Tabs groupId="operating-systems">
<TabItem value="linux" label="Linux">

```bash
curl -fsSL https://example.com/install.sh | bash
```

</TabItem>
<TabItem value="macos" label="macOS">

```bash
brew install example-tool
```

</TabItem>
<TabItem value="windows" label="Windows">

```powershell
winget install Example.Tool
```

</TabItem>
</Tabs>

**Verify installation:**

```bash
example-tool --version
```

Expected output: `example-tool version 1.2.3`

## Create Your First Project

### Step 1: Initialize

Create a new directory and initialize the project:

```bash
mkdir my-first-project
cd my-first-project
example-tool init
```

You'll see a success message:

```
✓ Project initialized successfully
✓ Configuration file created: config.yml
✓ Ready to get started!
```

### Step 2: Configure

Set up your basic configuration:

```bash
example-tool config set project.name "My First Project"
example-tool config set user.name "Your Name"
```

**Verify configuration:**

```bash
example-tool config show
```

### Step 3: Create a Resource

Create your first resource:

```bash
example-tool create item hello-world --description "My first resource"
```

Output:

```
✓ Created resource: hello-world (id: abc123)
```

### Step 4: View Your Resource

List all resources to see what you've created:

```bash
example-tool list
```

## Working with Configuration Files

Instead of using CLI commands, you can define resources in a configuration file:

```yaml title="resources.yml"
resources:
  - name: resource-one
    type: item
    description: First resource
    tags:
      - example
      - demo
  
  - name: resource-two
    type: item
    description: Second resource
    tags:
      - example
```

**Apply the configuration:**

```bash
example-tool apply --file resources.yml
```

## Next Steps

Congratulations! You've completed the quick start guide. Here's what to explore next:

1. **Learn More Commands:** Check out the [CLI Reference](#) for all available commands
2. **Advanced Configuration:** Read the [Configuration Guide](#) for customization options
3. **Troubleshooting:** Visit the [Troubleshooting](#) page if you encounter issues
4. **API Usage:** Explore the [API Reference](#) for programmatic access

## Quick Reference

### Essential Commands

| Command                  | Description                    |
|--------------------------|--------------------------------|
| `example-tool init`      | Initialize a new project       |
| `example-tool create`    | Create a new resource          |
| `example-tool list`      | List all resources             |
| `example-tool info <id>` | Show resource details          |
| `example-tool update <id>` | Update a resource            |
| `example-tool delete <id>` | Delete a resource            |
| `example-tool help`      | Show help information          |

### Useful Options

| Option            | Description                      |
|-------------------|----------------------------------|
| `--help, -h`      | Display help for any command     |
| `--verbose, -v`   | Show detailed output             |
| `--output, -o`    | Format output (json, yaml, table)|
| `--force, -f`     | Skip confirmation prompts        |

## Getting Help

If you need assistance:

- Run `example-tool help` for command documentation
- Check the [FAQ](#) for common questions
- Visit our [community forum](https://forum.example.com)
- Report issues on [GitHub](https://github.com/example/tool/issues)

:::tip Pro Tip
Use `example-tool --help` or `example-tool <command> --help` to see detailed information about any command and its options.
:::