---
title: "Quick Start"
description: "Get started with TraceRTM in 5 minutes"
keywords: [quick start, getting started, tutorial, setup]
---

# Quick Start

Get started with TraceRTM in 5 minutes.

## Step 1: Install TraceRTM

### Using pip

```bash
pip install tracertm
```

### Using Docker

```bash
docker run -d -p 8000:8000 tracertm/tracertm:latest
```

## Step 2: Configure

### Set API Key

```bash
# Using CLI
trace config set api-key rtm_live_abc123...

# Or environment variable
export TRACERTM_API_KEY="rtm_live_abc123..."
```

## Step 3: Create Your First Project

### Using CLI

```bash
trace project create "My First Project"
```

### Using Python SDK

```python
from tracertm import TraceRTM

client = TraceRTM(api_key="rtm_live_abc123...")
project = client.projects.create(
    name="My First Project",
    description="Getting started with TraceRTM"
)
print(f"Created project: {project.id}")
```

### Using API

```bash
curl -X POST "https://api.tracertm.dev/v1/projects" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My First Project",
    "description": "Getting started"
  }'
```

## Step 4: Create Items

### Create a Requirement

```python
requirement = client.items.create(
    title="User Authentication",
    view="requirements",
    status="draft",
    project_id=project.id
)
```

### Create a Test Case

```python
test_case = client.items.create(
    title="Login Test",
    view="test-cases",
    status="draft",
    project_id=project.id
)
```

## Step 5: Create Traceability Link

```python
link = client.links.create(
    source_id=requirement.id,
    target_id=test_case.id,
    link_type="verified_by"
)
```

## Complete Example

```python
from tracertm import TraceRTM

# Initialize client
client = TraceRTM(api_key="rtm_live_abc123...")

# Create project
project = client.projects.create(
    name="Authentication System",
    description="OAuth 2.0 implementation"
)

# Create requirement
req = client.items.create(
    title="OAuth 2.0 Support",
    view="requirements",
    project_id=project.id
)

# Create test case
test = client.items.create(
    title="OAuth Flow Test",
    view="test-cases",
    project_id=project.id
)

# Create traceability link
link = client.links.create(
    source_id=req.id,
    target_id=test.id,
    link_type="verified_by"
)

print(f"Created traceability: {req.title} --[verified_by]--> {test.title}")
```

## Next Steps

- [Installation](./01-installation) - Detailed installation guide
- [API Reference](/docs/api-reference) - Complete API documentation
- [CLI Guide](/docs/clients/cli-guide) - CLI usage guide
