---
sidebar_label: "FAQ"
sidebar_custom_props:
  section: "Templates"
  section_position: 1
---

{/*

FAQ pages answer frequently asked questions in a clear, concise format. Group related questions 
by category and provide direct, actionable answers. Keep answers brief but complete – link to 
other resources for detailed explanations.

*/}

# Frequently Asked Questions Template

Common questions and answers to help you get the most out of this technology.

## What platforms are supported?

Fully supported on:
- Linux (Ubuntu, Debian, Fedora, Arch)
- Windows (Windows 10 and 11)

## How do I install the tool?

Installation varies by platform. See the [Environment Setup](#) guide for detailed instructions. Quick install:

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

# Windows (PowerShell)
winget install Example.Tool
```

## Where is the configuration file located?

Configuration files are checked in this order:
1. `./config.yml` (project directory)
2. `~/.config/example-tool/config.yml` (user home)
3. `/etc/example-tool/config.yml` (system-wide)

## How do I update to the latest version?

```bash
# Using built-in updater
example-tool update

# Or reinstall via package manager
brew upgrade example-tool  # macOS
apt-get upgrade example-tool  # Ubuntu/Debian
```

## How do I initialize a new project?

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

## Can I use this with Docker?

Yes, official Docker images are available:

```bash
docker pull example/tool:latest
docker run -v $(pwd):/app example/tool:latest command
```

## How do I change the default port?

Update your configuration file or use environment variables:

```yaml
# config.yml
server:
  port: 9000
```

```bash
# Or via environment variable
export SERVER_PORT=9000
```

## How do I validate my configuration?

```bash
example-tool config validate
```

## Why am I getting "command not found"?

The tool isn't in your PATH. Add it manually:

```bash
export PATH="$PATH:/path/to/example-tool"

# Make permanent (add to ~/.bashrc or ~/.zshrc)
echo 'export PATH="$PATH:/usr/local/bin"' >> ~/.bashrc
```

## Why can't I connect to the API?

Check these common issues:
1. Verify the endpoint URL in your configuration
2. Ensure your API key is valid and not expired
3. Check network connectivity and firewall rules
4. Verify the service is running

```bash
# Test connectivity
curl -I https://api.example.com/health
```

## How do I enable debug logging?

```bash
# Via CLI flag
example-tool --verbose command

# Via environment variable
export LOG_LEVEL=debug
example-tool command

# Via config file
logging:
  level: debug
```

## What should I do if I encounter an error?

1. Check the error message and error code
2. Review the [Troubleshooting](#) guide
3. Enable debug logging to get more details
4. Search existing GitHub issues
5. Create a new issue with logs and steps to reproduce

## Is there a REST API client library?

Official clients are available for:
- JavaScript/TypeScript (npm: `@example/client`)
- Python (pip: `example-tool-client`)
- Go (github.com/example/go-client)