Skip to main content

đŸ“Ļ Installation

Tresor is distributed as a single compiled Go binary with no external dependencies. You can install it from a pre-built release or build from source.

đŸ“Ĩ Install from Release​

Linux / macOS — Setup Script​

The quickest way to get started — download the latest release with one command:

curl -fsSL https://raw.githubusercontent.com/Ladbaby/Tresor/main/setup.sh | bash

This script:

  • Detects your OS and architecture automatically (Linux amd64/arm64, macOS amd64/arm64)
  • Downloads the latest release binary from GitHub
  • Installs it to ~/.local/bin/tresor
  • Creates a config skeleton at ~/.config/tresor/config.yaml
  • Checks if ~/.local/bin is in your $PATH and warns if not

Note: This script only supports Linux and macOS. Windows users should build from source or download a release binary manually from GitHub Releases.

Windows​

Download a release binary manually from GitHub Releases, then place it in a directory on your PATH or reference it directly.

Build from Source​

For developers, unsupported platforms, or when you need the latest unreleased changes:

Prerequisites​

  • 🐹 Go 1.26+ — required for compilation

Compile​

go build -o tresor .

The compiled binary has no runtime dependencies — it's a single executable that includes the daemon, CLI, web UI, and SQLite database engine.

🚀 Quick Start​

1ī¸âƒŖ Configure Your API Keys​

If you used the setup script:

Edit ~/.config/tresor/config.yaml to add your provider API keys:

downstreams:
  - id: openai-gpt4o
    name: OpenAI GPT-4o
    base_url: https://api.openai.com/v1
    api_key: sk-proj-...   # Replace with your API key

  - id: anthropic-sonnet
    name: Anthropic Claude Sonnet
    base_url: https://api.anthropic.com
    api_key: sk-ant-...    # Replace with your API key

If you built from source:

Copy the example configuration and customize it:

cp config.example.yaml config.yaml

Then edit config.yaml to add your provider API keys.

2ī¸âƒŖ Start the Daemon​

tresor run --config ~/.config/tresor/config.yaml

The daemon starts listening on the configured bind_addr. The gateway and admin API are available on this address.

3ī¸âƒŖ Point Your Application​

Configure your application's LLM client to use Tresor as the endpoint:

base_url: http://127.0.0.1:11510

Any request sent to Tresor is intercepted, routed to the appropriate downstream, and the response is returned — all transparently.

4ī¸âƒŖ Open the Web UI​

Navigate to http://127.0.0.1:11510 in your browser to access the embedded dashboard. The web UI features a login screen (if admin_password is set), dark/light theme toggle, and tabs for managing downstreams, aliases, rules, plugins, settings, and an about panel.

📂 Config File Locations​

Tresor auto-detects the config file in this order:

  1. Path specified by --config flag
  2. ./config.yaml in the current working directory
  3. $HOME/.tresor.yaml in your home directory

The setup script places config at ~/.config/tresor/config.yaml — use --config to point to it explicitly.

ℹī¸ Version Info​

Check the installed binary's version:

tresor version