Trellis documentation
Overview

Documentation

Trellis Guides

Introduction

  • Trellis Concepts

    The core ideas behind Trellis — contracts, communication, auth, resources, and packages.

Server Setup

  • Install the Trellis CLI

    Install the trellis command-line tool from a GitHub release or build it with Cargo.

  • Prepare NATS

    A running NATS server with the accounts, credentials, and signing keys that Trellis expects.

  • Starting Trellis

    A running Trellis instance with an admin account ready for development.

Development

  • Write a TypeScript service

    A working backend service that connects to Trellis, handles RPCs, and subscribes to events.

  • Write a SvelteKit app

    A working browser app that authenticates with Trellis and calls RPCs.

Administration

  • Install a service from an image

    Deploy a published service from an OCI image into a running Trellis environment.

  • Install a service from source

    Install and run a service from its source tree during development.

Contributing

  • In-repo development

    Run the Trellis server, console, and NATS from the source tree for local development.