Skip to content

Quick start

Run Trestl locally and create your first account.

View source

Trestl is a project workspace for personal projects and small teams. Use the desktop app for a local workspace, or Docker Compose for a shared self-hosted installation.

Desktop app

Trestl Desktop includes its runtime and embedded database; it does not require Node.js, Docker, or a server. Signed installers will be attached to GitHub Releases once code signing is configured. Until then, unsigned test installers are available from the Desktop installers workflow in GitHub Actions. See the desktop guide for installation, platform requirements, updates, and backups.

The commands below run the web application from source.

Before you begin

You need Node.js 22.9+, pnpm 10.7.1, and Git.

Start Trestl

git clone https://github.com/saynain/trestl.git
cd trestl
corepack enable
pnpm install --frozen-lockfile
pnpm dev

Open http://127.0.0.1:5173. The API runs on port 4317. Your local data persists in .data/ through PGlite; no external database is required.

Make it yours

On your first visit, name the installation and create your administrator account with your name, email, and password. There are no default credentials. Start empty or choose to include example projects.

One installation supports one person or a team. Keep private tasks in your Personal inbox, and use projects to organize shared work. Administrators manage people and authentication in Administration. Your profile, appearance, and API tokens live in Account settings, available from the account menu at the bottom of the sidebar.

Capture your first task

Use quick capture on Home to add a task, follow-up, or someday idea. It starts in your private inbox without needing a project. Open the item to add details, dates, or a project when you're ready.

Use ⌘K / Ctrl+K to open search and C to create a work item when you're not typing in a field. See the user guide for boards, timelines, roadmaps, and canvases.

Choose your next step

Trestl is an early release. Run one application instance, back up before upgrading, and retain your APP_SECRET. See the deployment guide for operational limits and backup instructions.