### Quickstart Local Setup with Make

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/Getting_Started/First_Time_Audio_Setup_CPU.md

Clones the repository and performs a quick installation and local setup using make commands.

```bash
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server
make quickstart-install
make quickstart-local
```

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

### Quick Start Installation and Configuration

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Deployment/minimal-deploy.md

Install the package, copy and edit the example environment file, initialize authentication, and start the server using uvicorn.

```bash
# Install
pip install -e .

# Configure
cp tldw_Server_API/Config_Files/.env.example tldw_Server_API/Config_Files/.env
# Edit .env: set AUTH_MODE=single_user, add API keys

# Initialize auth
python -m tldw_Server_API.app.core.AuthNZ.initialize

# Start
python -m uvicorn tldw_Server_API.app.main:app --host 0.0.0.0 --port 8000
```

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

### Setup Local WebUI Development Environment

Source: https://github.com/rmusser01/tldw_server/blob/main/apps/DEVELOPMENT.md

Navigate to the frontend directory, copy the example environment file, install dependencies, and start the development server. The `-p 8080` flag specifies the port.

```bash
# from repo root
cd apps/tldw-frontend
cp .env.local.example .env.local
bun install
bun run dev -- -p 8080
```

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

### Local Installation Setup and Start

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/QUICKSTART.md

Install tldw server dependencies locally into a virtual environment and start the server. This method does not use Docker.

```bash
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server

make quickstart-install

make quickstart-local
```

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

### Basic Local Deployment Setup

Source: https://github.com/rmusser01/tldw_server/blob/main/tldw_Server_API/app/core/TTS/TTS-DEPLOYMENT.md

Steps to clone the repository, set up a virtual environment, install dependencies, configure settings, and start the server locally. Assumes Python and pip are installed.

```bash
# Clone repository
git clone https://github.com/your-repo/tldw_server.git
cd tldw_server

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -e .

# Configure
cp Config_Files/Backup_Config.txt config.txt
# Edit config.txt with your settings

# Create YAML config
cat > tldw_Server_API/app/core/TTS/tts_providers_config.yaml << EOF
# Add your YAML configuration here
EOF

# Start server
python -m uvicorn tldw_Server_API.app.main:app \
    --host 0.0.0.0 \
    --port 8000 \
    --workers 4
```

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

### Install Quickstart Prerequisites

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Website/index.html

Run this command after cloning the repository to install necessary prerequisites for the quickstart.

```bash
cd tldw_server
make quickstart-prereqs
```

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

### Quickstart Installation with Make

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/First_Time_Audio_Setup_GPU_Accelerated.md

Clones the repository and performs a quick installation using the make utility. This is a recommended path for accelerated hardware.

```bash
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server
make quickstart-install
make quickstart-local
```

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

### Clone Repository and Start Docker Quickstart

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/QUICKSTART.md

Use this command to clone the tldw_server repository and initiate a quick Docker setup for a single-user environment.

```bash
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server

cp tldw_Server_API/Config_Files/.env.example tldw_Server_API/Config_Files/.env

make quickstart
```

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

### Test README Quickstart Entrypoint

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Plans/2026-03-15-default-production-onboarding.md

Asserts that the README file correctly points the 'make quickstart' command to the Docker single-user setup and that it appears before the local single-user setup. Also checks for the inclusion of development documentation.

```python
from pathlib import Path


def test_readme_points_first_quickstart_to_docker_single_user() -> None:
    text = Path("README.md").read_text()
    assert "make quickstart" in text
    assert "Docker single-user" in text
    assert text.index("make quickstart") < text.index("Local single-user")
    assert "apps/DEVELOPMENT.md" in text
```

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

### Quick Setup for tldw_Server_API

Source: https://github.com/rmusser01/tldw_server/blob/main/tldw_Server_API/README.md

Copy the example environment file and initialize the authentication module for quick setup. Configure provider keys in .env or config.txt.

```bash
cp tldw_Server_API/Config_Files/.env.example tldw_Server_API/Config_Files/.env
python -m tldw_Server_API.app.core.AuthNZ.initialize
```

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

### Docker + WebUI Setup

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/Getting_Started/First_Time_Audio_Setup_CPU.md

Configures the environment for Docker-based setup, including copying example environment file and starting services with Docker Compose.

```bash
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server
cp tldw_Server_API/Config_Files/.env.example tldw_Server_API/Config_Files/.env
```

```bash
docker compose --env-file tldw_Server_API/Config_Files/.env \
  -f Dockerfiles/docker-compose.yml \
  -f Dockerfiles/docker-compose.webui.yml \
  up -d --build
```

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

### JavaScript: Begin Install Status Monitoring

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/Code_Documentation/Setup_UI_Developer_Guide.md

Once setup is complete with an install plan, `beginInstallStatusMonitoring()` in `setup.js` initiates polling for installation progress and updates the progress card.

```javascript
beginInstallStatusMonitoring()
```

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

### JavaScript: Begin Install Status Monitoring

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Code_Documentation/Setup_UI_Developer_Guide.md

Once setup completes with an installation plan, `beginInstallStatusMonitoring()` in `setup.js` initiates polling for installation progress. It updates the progress card and reminds users about the ongoing installation of Python dependencies and model files.

```javascript
beginInstallStatusMonitoring()
```

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

### Self-hosting Setup

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/Code_Documentation/Code_Map.md

Centralized commands for self-hosting setup can be found in `Docs/Getting_Started/README.md` and specific profile guides.

```markdown
Docs/Getting_Started/README.md
```

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

### Setup VibeVoice Repository and Install

Source: https://github.com/rmusser01/tldw_server/blob/main/tldw_Server_API/app/core/TTS/TTS-DEPLOYMENT.md

Clones the VibeVoice repository from GitHub, navigates into the directory, and installs the package in editable mode.

```bash
# Clone VibeVoice repository
git clone https://github.com/microsoft/VibeVoice.git
cd VibeVoice
pip install -e .
```

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

### Run Quickstart Commands

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Plans/2026-03-21-tldw-homepage-setup-copy-design.md

These commands are used for setting up the project. Use 'make quickstart' for the default setup, 'make quickstart-docker' for a Docker-based alternative, 'make quickstart-install' for a local development path without Docker, and 'make quickstart-prereqs' to check prerequisites.

```bash
make quickstart
```

```bash
make quickstart-docker
```

```bash
make quickstart-install
```

```bash
make quickstart-prereqs
```

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

### Start tldw_server with Uvicorn

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/STT-TTS/CHATTERBOX_SETUP.md

Command to start the tldw_server backend using Uvicorn. Access the API documentation and quickstart guide via the provided URLs.

```bash
python -m uvicorn tldw_Server_API.app.main:app --reload
# API docs: http://127.0.0.1:8000/docs
# Quickstart: http://127.0.0.1:8000/api/v1/config/quickstart
```

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

### Clone Repository and Initial Setup

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/Profile_Docker_Multi_User_Postgres.md

Clone the project repository and copy the example environment file. This is the first step in setting up the server.

```bash
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server
cp tldw_Server_API/Config_Files/.env.example tldw_Server_API/Config_Files/.env
```

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

### Start the uvicorn server

Source: https://github.com/rmusser01/tldw_server/blob/main/CLAUDE.md

Use this command to start the development server with hot-reloading. Access API docs and quickstart guides via the provided URLs.

```bash
python -m uvicorn tldw_Server_API.app.main:app --reload
# API docs:   http://127.0.0.1:8000/docs
# Quickstart: http://127.0.0.1:8000/api/v1/config/quickstart
# Setup UI:   http://127.0.0.1:8000/setup (if required)
```

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

### API Endpoint for Installer Status

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/Code_Documentation/Setup_UI_Developer_Guide.md

This GET request exposes the progress of background installations, including dependency and model provisioning. The Setup UI polls this endpoint.

```text
GET /api/v1/setup/install-status
```

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

### Quick Start Server Setup for Local Benchmarking

Source: https://github.com/rmusser01/tldw_server/blob/main/Helper_Scripts/benchmarks/README.md

Starts a local development server using `make` with specific host, port, and API key. This configuration includes essential settings for safe local benchmarking.

```bash
make server-up-dev HOST=127.0.0.1 PORT=8000 API_KEY=dev-key-123
```

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

### Basic Report Generation Example

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Design/Researcher.md

This Python notebook demonstrates basic report generation using llama_cloud_services. It serves as an introductory example for users to get started with the library.

```python
from llama_cloud_services import LlamaCloud

# Initialize the LlamaCloud client
lc = LlamaCloud(api_key="YOUR_API_KEY")

# Define the report content
report_content = {
    "title": "Quarterly Sales Report",
    "sections": [
        {
            "heading": "Introduction",
            "content": "This report summarizes the sales performance for the last quarter."
        },
        {
            "heading": "Key Metrics",
            "content": "Total Revenue: $1.2M, New Customers: 500, Churn Rate: 2%"
        },
        {
            "heading": "Conclusion",
            "content": "Overall, the quarter showed strong performance with significant growth in new customer acquisition."
        }
    ]
}

# Generate the report
response = lc.generate_report(report_content)

# Print the generated report (or save it to a file)
print(response.report)
```

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

### Install Dependencies and Run Development Servers

Source: https://github.com/rmusser01/tldw_server/blob/main/apps/Shared_UI_Monorepo.md

Navigate to the 'apps' directory, install dependencies using Bun, and then start the development servers for either the extension or the web UI.

```bash
cd apps
bun install

# Extension development
bun run --cwd extension dev

# Web development
bun run --cwd tldw-frontend dev
```

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

### Set Up Development Environment

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/API-related/Embeddings_Module_Documentation.md

Steps to clone the repository, create and activate a virtual environment, install dependencies, and run tests.

```bash
# Clone repository
git clone https://github.com/your-org/tldw_server
cd tldw_server

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Linux/Mac
# or
virtualenv\Scripts\activate  # Windows

# Install dependencies
pip install -e ".[dev]"

# Run tests
pytest tests/Embeddings/ -v
```

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

### API Endpoint for Installation Status

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Code_Documentation/Setup_UI_Developer_Guide.md

This GET request exposes the progress of background installations, including dependency provisioning and model downloads. The Setup UI polls this endpoint to display real-time status updates.

```text
GET /api/v1/setup/install-status
```

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

### Provide README Guidance

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/superpowers/plans/2026-03-24-quickstart-webui-shared-runtime-followup-implementation-plan.md

Offers top-level guidance for quickstart setups and advanced configuration overrides.

```markdown
README.md
```

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

### Run Quickstart with Docker + WebUI

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Website/index.html

This command sets up and runs the tldw_server stack using Docker and the WebUI. It's the recommended setup.

```bash
cd tldw_server
make quickstart
```

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

### Manual Local Python Setup (Linux/macOS)

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/Getting_Started/First_Time_Audio_Setup_CPU.md

Sets up a local Python virtual environment, installs the project, and starts the Uvicorn server. Requires Python 3.10+.

```bash
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -e .
python -m uvicorn tldw_Server_API.app.main:app --reload
```

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

### Local Python Setup on Windows

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/First_Time_Audio_Setup_GPU_Accelerated.md

Sets up a local Python environment using PowerShell, installs the project, and starts the development server. Requires Python 3.10+.

```powershell
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server
py -3.12 -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
pip install -e .
python -m uvicorn tldw_Server_API.app.main:app --reload
```

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

### Run Quickstart with Docker Compose

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/Profile_Docker_Single_User.md

Execute the make quickstart command for a streamlined Docker setup. Alternatively, use the manual docker compose command with specified environment file and compose files.

```bash
make quickstart
```

```bash
# Manual equivalent if you are not using make:
docker compose --env-file tldw_Server_API/Config_Files/.env \
  -f Dockerfiles/docker-compose.yml \
  -f Dockerfiles/docker-compose.webui.yml up -d --build
```

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

### Local Python Setup on Linux/macOS

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/First_Time_Audio_Setup_GPU_Accelerated.md

Sets up a local Python environment, installs the project, and starts the development server using uvicorn. Requires Python 3.10+.

```bash
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server
python3 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -e .
python -m uvicorn tldw_Server_API.app.main:app --reload
```

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

### Manual Local Python Setup (Windows PowerShell)

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/Getting_Started/First_Time_Audio_Setup_CPU.md

Sets up a local Python virtual environment using PowerShell, installs the project, and starts the Uvicorn server. Requires Python 3.10+.

```powershell
git clone https://github.com/rmusser01/tldw_server.git
cd tldw_server
py -3.12 -m venv .venv
.\.venv\Scripts\Activate.ps1
python -m pip install --upgrade pip
pip install -e .
python -m uvicorn tldw_Server_API.app.main:app --reload
```

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

### API Key Location Hint Example

Source: https://github.com/rmusser01/tldw_server/blob/main/apps/extension/docs/Onboarding-i18n-Notes.md

This string should guide users on where to find their API key. UX audit tests look for patterns like 'where to find' or 'how to get'.

```javascript
tldw_server → Settings → API Keys
```

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

### Initialize AuthNZ Configuration

Source: https://github.com/rmusser01/tldw_server/blob/main/README.md

Copy the example environment file and then run this command to initialize the AuthNZ setup.

```bash
cp tldw_Server_API/Config_Files/.env.example tldw_Server_API/Config_Files/.env && python -m tldw_Server_API.app.core.AuthNZ.initialize
```

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

### GET /api/v1/chat/commands Response Example

Source: https://github.com/rmusser01/tldw_server/blob/main/README.md

Example JSON response for the GET /api/v1/chat/commands endpoint, listing available chat commands and their permissions.

```json
{
  "commands": [
    {"name": "time", "description": "Show the current time (optional TZ).", "required_permission": "chat.commands.time"},
    {"name": "weather", "description": "Show current weather for a location.", "required_permission": "chat.commands.weather"}
  ]
}
```

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

### GET /runtimes Response Example

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Product/Sandbox/Code_Interpreter_Sandbox_PRD.md

Example response from the GET /runtimes endpoint, showing supported spec versions and runtime capabilities.

```json
{
  "max_cpu": 4.0,
  "max_mem_mb": 8192,
  "max_log_bytes": 10485760,
  "queue_max_length": 100,
  "queue_ttl_sec": 3600,
  "workspace_cap_mb": 10240,
  "artifact_ttl_hours": 168,
  "supported_spec_versions": ["1.0", "1.1"],
  "interactive_supported": true,
  "egress_allowlist_supported": false,
  "store_mode": "memory"
}
```

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

### Development Installation and Testing

Source: https://github.com/rmusser01/tldw_server/blob/main/tldw_Server_API/app/core/Evaluations/README.md

Steps for cloning the repository, installing with development dependencies, and running tests for the Evaluations module.

```bash
# Clone repository
git clone https://github.com/your-repo/tldw_server
cd tldw_server

# Install with dev dependencies
pip install -e ".[dev,evals]"

# Run tests
pytest tests/Evaluations/ -v
```

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

### Run Pytest for Setup Installation Integration Tests

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Plans/2026-03-15-audio-setup-bundles-implementation-plan.md

Command to execute pytest for integration tests related to the setup installation process. This is used to verify backend changes affecting the setup flow.

```bash
source .venv/bin/activate && python -m pytest tldw_Server_API/tests/integration/test_setup_installation.py -q
```

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

### Systemd Service and Timer Setup

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Deployment/Sidecar_Workers.md

Steps to set up a TLDW worker as a systemd service on Linux. This involves copying example units, updating paths and user/group settings, and enabling/starting the service. Timers are optional and can trigger a one-time start.

```bash
sudo cp Docs/Deployment/systemd/tldw-worker-chatbooks.service /etc/systemd/system/
sudo cp Docs/Deployment/systemd/tldw-worker-chatbooks.timer /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable --now tldw-worker-chatbooks.service
```

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

### Run Quickstart Docker with WebUI

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/README.md

Execute this command from the repository root to set up the Docker single-user environment with the WebUI, using the recommended default browser flow with same-origin browser API requests through the WebUI proxy.

```bash
make quickstart
```

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

### Style Guide Template Example

Source: https://github.com/rmusser01/tldw_server/blob/main/apps/extension/docs/Product/WIP/Chat-ST-PRD.md

An example of how the Prose Dials are formatted into a 'Style Guide' block for prompt injection. This block summarizes the active style settings.

```text
Style Guide:
- Density: Dense
- Vocabulary: Ornate
- Pacing: Slow
- Show vs Tell: Show
- POV: Close
- Genre: Gothic mystery
- Style principles: [bullet1; bullet2]
- Example (short): "..."
- User agency: Do not narrate user actions or thoughts.
```

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

### Run Quickstart Docker API-Only

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Getting_Started/README.md

Use this command if you prefer the API-only Docker setup without the WebUI.

```bash
make quickstart-docker
```

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

### Commit Changes for Mounting Audio Installer in Options Setup

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Plans/2026-03-19-admin-audio-installer-shared-ui-implementation-plan.md

Git commands to stage and commit the files modified for integrating the audio installer into the extension/options setup UI.

```bash
git add apps/packages/ui/src/routes/option-setup.tsx apps/packages/ui/src/routes/__tests__/option-setup-audio-installer.test.tsx
git commit -m "feat: surface audio installer in extension setup"
```

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

### Install Project Prerequisites

Source: https://github.com/rmusser01/tldw_server/blob/main/README.md

Run this command to install necessary prerequisites for the Makefile quickstart targets. If 'make' is unavailable, manual checks for Python, ffmpeg, and Docker versions are required.

```bash
make quickstart-prereqs
```

```powershell
py -3.12 --version  # or py -3.13 / -3.11 / -3.10
ffmpeg -version
docker --version    # only if using Docker paths
```

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

### Run Vitest for Options Setup Audio Installer Test

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Plans/2026-03-19-admin-audio-installer-shared-ui-implementation-plan.md

Command to run the Vitest tests specifically for the integration of the audio installer within the options setup UI.

```bash
bunx vitest run apps/packages/ui/src/routes/__tests__/option-setup-audio-installer.test.tsx
```

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

### Set Up Local Environment Variables

Source: https://github.com/rmusser01/tldw_server/blob/main/admin-ui/README.md

Copies the example environment file to a local file for customization. Ensure you configure `NEXT_PUBLIC_API_URL`.

```bash
cp .env.example .env.local
```

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

### Start Docker Single-User + WebUI Setup

Source: https://github.com/rmusser01/tldw_server/blob/main/README.md

This Makefile target starts the Docker single-user setup with the WebUI, making the API available at http://localhost:8000 and the WebUI at http://localhost:8080.

```bash
# from repo root
make quickstart
```

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

### Python Client Usage Example

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/API-related/CHARACTER_CHAT_API_DOCUMENTATION.md

Demonstrates how to instantiate and use the CharacterChatClient to create a character, start a chat, send a message, and get an AI completion. Replace "http://localhost:8000" and "your-api-key" with your actual API endpoint and key.

```python
# Usage
client = CharacterChatClient("http://localhost:8000", "your-api-key")

# Create a character
character = client.create_character(
    name="Assistant",
    description="A helpful AI assistant",
    personality="Friendly and knowledgeable",
    first_message="Hello! How can I help you?"
)

# Start a chat
chat = client.create_chat(character["id"], "Evening Chat")

# Send message
message = client.send_message(chat["id"], "Hello!")

# Get AI response through chat completions
response = client.get_completion(chat["id"], "Tell me a joke")
if "response" in response:
    print(response["response"])
else:
    print("Error getting completion:", response)
```

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

### Capture Starter Command and Safety Choices in Review Summary

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Plans/2026-03-14-persona-setup-connection-hints-starter-pack-review-implementation-plan.md

Write tests to capture starter commands and safety choices into a setup review summary. Ensure the handoff content originates from the setup run.

```typescript
it("captures starter command and safety choices into a setup review summary", async () => {
  ...
  expect(screen.getByTestId("persona-setup-handoff-card")).toHaveTextContent(
    "Added 3 starter commands"
  )
  expect(screen.getByTestId("persona-setup-handoff-card")).toHaveTextContent(
    "Ask for destructive actions"
  )
  expect(screen.getByTestId("persona-setup-handoff-card")).toHaveTextContent(
    "Connection added: Slack Alerts"
  )
})
```

```typescript
it("records skipped starter commands and skipped connections explicitly", async () => {
  ...
})
```

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

### Install Qwen2Audio Dependencies

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/User_Guides/WebUI_Extension/Getting-Started-STT_and_TTS.md

Install the necessary Python packages for using Qwen2Audio locally. An optional setup installer can prefetch assets.

```bash
pip install torch transformers accelerate soundfile sentencepiece
```

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

### Run Quickstart with API-only Docker

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Website/index.html

Use this command to set up and run a Dockerized tldw_server stack that only includes the API.

```bash
cd tldw_server
make quickstart-docker
```

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

### Restart Server with make quickstart-local

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Published/Getting_Started/First_Time_Audio_Setup_CPU.md

Restart the server using the 'make quickstart-local' command for local development setups. This command stops and then starts the server to apply configuration changes.

```bash
# stop the server, then start it again
make quickstart-local
```

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

### Run Documentation Development Server

Source: https://github.com/rmusser01/tldw_server/blob/main/apps/extension/Contributing.md

Starts a development server for viewing documentation locally.

```bash
bun run docs:dev
```

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

### Install Dependencies and Start Local API Server

Source: https://github.com/rmusser01/tldw_server/blob/main/README.md

This Makefile target installs project dependencies into a virtual environment and starts the local API server. It also creates the .env configuration file if it doesn't exist.

```bash
# from repo root
make quickstart-install
```

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

### Resume to Setup Behavior

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/Plans/2026-03-14-persona-setup-no-match-command-detour-design.md

Details the expected behavior when returning to the setup wizard after saving a command during a detour, including restoring the overlay, step, and prefilling the dry-run textarea.

```typescript
// After save:
// - route re-enters setup overlay
// - current step is `test`
// - dry-run textarea is prefilled with the original phrase
// - success note appears once:
//   - `Command saved. Run the same phrase again to confirm setup.`
```

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

### Install Backend and Frontend Dependencies

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/superpowers/plans/2026-04-18-acp-prototype-workspace-collaboration-implementation-plan.md

Activate the Python virtual environment and install backend dependencies. Then, navigate to the UI directory and install frontend packages using Bun, ensuring the lockfile is frozen. This step verifies Python environment setup and prepares frontend packages.

```bash
source .venv/bin/activate && python -V
```

```bash
cd apps && bun install --frozen-lockfile
```

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

### Python Example for tldw_server

Source: https://github.com/rmusser01/tldw_server/blob/main/Docs/quickstart-interactive.html

This is a Python code example for interacting with the tldw_server. Ensure you have the necessary libraries installed.

```python
Loading...
```