# Shelley

> Shelley is a web-based, mobile-friendly, multi-conversation, multi-modal, multi-model coding agent. One binary. Open source and self-modifying. Source: https://github.com/boldsoftware/shelley

## Getting started

- [What is Shelley?](https://shelley.dev/docs/index.md): An open source coding agent that you run yourself and use from a browser tab.
- [Installation](https://shelley.dev/docs/install.md): Get the binary, give it a model, serve it, keep it up to date, and run it as a service.
- [Models and API keys](https://shelley.dev/docs/models.md): Which keys Shelley reads, what each one turns on, and how to add any other model.
- [Running it safely](https://shelley.dev/docs/security.md): What Shelley protects (not much), what it doesn't, and how to run it without handing your machine to the network.
- [Shelley on exe.dev](https://shelley.dev/docs/exe-dev.md): Where Shelley lives on an exe.dev VM, where its models come from, and how to upgrade, customize, or turn it off.

## Using Shelley

- [Conversations](https://shelley.dev/docs/conversations.md): How the web UI is organized and used day to day: conversations, models, directories, the composer, recordings, subagents, diffs, terminals, and context.
- [Tools](https://shelley.dev/docs/tools.md): What the agent can do (shell, file edits, a headless browser, subagents, other models, inline HTML) and how to turn each tool on or off.
- [Commit tours](https://shelley.dev/docs/commit-tours.md): A guided walkthrough of a commit's diff, written by the agent, stored as a git note, and shown in Shelley's diff viewer.

## Customizing

- [Self-modifying Shelley](https://shelley.dev/docs/self-modifying.md): Ask Shelley to change its own source. It builds the change, offers to install it, and rebases it onto new releases.
- [AGENTS.md](https://shelley.dev/docs/agents-md.md): Which guidance files Shelley reads, where it looks for them, and how they reach the model.
- [Skills](https://shelley.dev/docs/skills.md): Instructions the model loads only when a task needs them. Built-in skills, your own, and the SKILL.md format.
- [MCP servers](https://shelley.dev/docs/mcp.md): Connecting Shelley to remote MCP servers, logging in with OAuth, and how the agent calls their tools.
- [Hooks](https://shelley.dev/docs/hooks.md): Executable scripts in ~/.config/shelley/hooks that rewrite prompts and messages, add slash commands, or react when a turn ends.

## Reference

- [Command line](https://shelley.dev/docs/cli.md): Every shelley subcommand and flag, from the binary's own help.
- [shelley.json](https://shelley.dev/docs/config.md): The optional config file, its two fields, and the environment variables Shelley reads.

## Help

- [FAQ](https://shelley.dev/docs/faq.md): Questions people ask about Shelley, and a few they don't.