• Get started

    • Getting started
    • Concepts
    • Tour
  • Using shpyrd

    • Deploying
    • shpyrd.yaml
    • Resources
    • Databases and caches
    • Domains and exposure
    • Sign-in for your app
    • Teams, roles and security
    • AI assistants (MCP)
    • Logs
    • Dashboard
    • CLI reference
  • Running it yourself

    • Installation
    • Oracle Cloud (OKE)
    • AWS (EKS)
    • Extensions and sign-in
    • Platform backups
    • Architecture guide
  • Project

    • Design principles
    • Roadmap
    • How to contribute
    • Support the project
  1. Get started
  2. Getting started
Add toClaudeClaude CodeClaudeClaudeOpenAICodexCursorCursorVisual Studio CodeVS Code

Getting started

Install shpyrd - with the installer, or by hand - then ask your agent to put your app online and share it with your team.

You built an app with your agent. shpyrd is where it goes next: its own address, a sign-in in front of it, and the colleagues you choose inside. You don't learn a new tool to get there - you add shpyrd to the agent you already use, and tell it what you want.

1. Install shpyrd

With the installer

Download it for your computer and open it. It installs the shpyrd CLI, adds shpyrd to every AI agent it finds on your computer, and offers to sign you in.

  • macOS: Shpyrd-Installer.dmg
  • Windows: Shpyrd-Installer.exe
  • Linux: Shpyrd-Installer-linux-amd64.tar.gz

Manually

The same three things the installer does.

Add shpyrd to your agent. shpyrd has a server for AI agents at https://mcp.shpyrd.io/mcp. It needs no account: it tells your agent how to build an app that runs on shpyrd - where it keeps its data, how it knows who is signed in - and where the documentation is. Pick the agent you use and add it once:

In a terminal:

claude mcp add --transport http shpyrd https://mcp.shpyrd.io/mcp

It needs no account: it tells your agent how to build apps that run on shpyrd, and where the documentation is.

Install the shpyrd CLI. It is how your agent puts apps online and shares them, as you. On macOS and Linux:

curl -fsSL https://shpyrd.io/install.sh | sh# or, with Homebrewbrew install shpyrd-io/tap/shpyrd

Sign in.

shpyrd login

Your browser opens on shpyrd cloud. Sign in, or sign up and name your free workspace - it answers at its own address, like acme.shpyrd.app, and every app you put online gets an address under it. Then approve the code your terminal shows. The CLI is signed in as you for 30 days, and never with more than your roles allow.

2. Talk to it

In the folder of your app, say what you want, the way you'd say it to a colleague:

ClaudeClaude Code~/projects/purchases
  1. You

    Put this app online on shpyrd.

  2. ClaudeClaude Code
    • Deployed purchase-requests · release 1
    • purchases.acme.shpyrd.app is live · sign-in required

    Done. It's at purchases.acme.shpyrd.app, behind your workspace's sign-in. Nobody else can open it yet.

  3. You

    Share it with the Finance team, and let Ana change it too.

  4. ClaudeClaude Code
    • Finance · can use
    • ana@acme.com · can update

    Done. Everyone in Finance can open it - and whoever joins Finance later. Ana can deploy updates and roll them back.

And a week later:

ClaudeClaude Code~/projects/purchases
  1. You

    Finance says the totals are wrong since this morning.

  2. ClaudeClaude Code
    • Read the logs of release 3: errors in /totals since 09:12
    • Rolled back to release 2

    Release 3 broke the totals, so everyone is on release 2 again - its code and its settings. Want me to look at the fix?

The people you shared it with sign in with their account and find the app among theirs. Sign-in for your app and Teams, roles and security say who can do what.

How your agent does it

Before it writes code, your agent reads from shpyrd's server how an app should be built to run there. To put it online, share it and roll it back, it runs the shpyrd CLI for you, signed in as you. To also let it read your projects, logs and metrics from anywhere, add your workspace's own server - Connecting AI assistants says how.

What you get

  • An address and a sign-in for every app. People sign in before a request reaches your app, and the app is told who they are - no login code of its own.
  • Access by team or by person. Your company's sign-in, its groups as teams, and separate rights to use an app, to change it and to manage it.
  • Changes you can take back. Every deploy or settings change is a numbered release; going back restores the code and the settings together.
  • What apps need to run. Databases and caches, settings that stay secret, logs and metrics - and apps that sleep when nobody uses them and wake on the next visit.

Prefer commands?

Everything your agent does is an ordinary command you can type yourself: Deploying walks through them, and the CLI reference lists them all.

Running it yourself

shpyrd is open source (MPL-2.0) and runs on a Kubernetes cluster of your own too - on your laptop, on AWS or on Oracle Cloud. Installation has every step.

Status

shpyrd is in beta and developed in the open. The roadmap shows what is done and what comes next; how to contribute explains the way in.

Getting help

  • Bugs, ideas and questions: GitHub issues.
  • Community chat: Discord.

On this page

  • 1. Install shpyrd
  • With the installer
  • Manually
  • 2. Talk to it
  • What you get
  • Prefer commands?
  • Running it yourself
  • Status
  • Getting help
  • Docs

shpyrd is open source under MPL-2.0, and in beta.