Home

Slingshot Wiki

• Slingshot lets a light machine use the CPU, RAM, and GPU of a powerful one. Builds, servers, containers, and coding agents run on the powerful machine, while you keep your own editor, terminal, and browser.
• The Client is the machine you work on. The Agent is the powerful machine.
• This wiki is a map. Every doc lives in the repository, and the links here point there, so there is only one copy to keep current.
• The sidebar links every doc and section.

Contents

1. Start Here
2. Find The Right Doc
3. Common Questions
4. Project Links

Start Here

1. Install Slingshot on both machines with cargo install slingshot-cli. What each machine needs is in Install.
2. On the Agent, run slingshot start. It checks the machine and prints a pairing code.
3. On the Client, run the slingshot link line it printed. Both machines must share a network or tailnet for this step only. Slingshot then offers to install your tools on the Agent.
4. In a project folder on the Client, run slingshot run cargo build, or open a lasting session with slingshot attach.

Find The Right Doc

If You Want To Know	Read
Every command and option	Usage
What an error message means, and its fix	Troubleshooting
What works, what was tested, and what comes next	Roadmap
How the parts fit together, and what every file does	Architecture
How to set up, change, and test the code	Contributing

Common Questions

Question	Answer
Does it need Tailscale or another VPN?	No. A VPN is used when present. After linking, iroh reaches the Agent from any network, with no account and no router setup. See How The Client Reaches The Agent.
Can I link from another network?	Not yet. Linking needs a shared network or tailnet once. See #19.
What is copied to the Agent?	Source files only. Never .git, build output such as target and node_modules, or .env files. See What Slingshot Copies.
How do I bring a coding agent's edits back?	Run slingshot sync --pull. A file changed on both machines stops the sync, and nothing is lost. See Keep Files In Step.
What happens if my connection drops?	A run stops. A session from slingshot attach keeps running, and attach returns to it. See Run Work.
Can I open a dev server in my browser?	Not yet. Port forwarding is planned in #9.
Does it run local AI models?	Planned. Ollama already works by hand inside slingshot attach. See #20.
Can a Mac be the Agent?	Yes, with tmux and Remote Login on. See Install. Windows is not supported.
Is it safe?	The pairing code never crosses the network, each Client has its own key, and nothing runs as another user. See Security.

Project Links

Link	What It Has
README	What Slingshot does, and the short setup.
Issues	Bugs and planned work.
Tracking Issue	What is left before port forwarding and local models, in order.
Pull Requests	Changes waiting for review.