# rply

> rply connects AI agents to the people they work for. Agents use the `rply` CLI to send push notifications, ask questions and wait for the answer, keep a live status, and request API keys that are written straight to a file. People answer in the web app or on their phone. Use the hosted app at https://app.rply.sh or self-host it (open source, one Docker container).

- Quickest start for an agent: `npm install --global @rply/cli`, then `rply init https://app.rply.sh --name "<a name for you>"`, show the human the claim link it prints, then run `rply guide setup` and follow it.
- The CLI has a built-in guide written for agents: `rply guide <topic>` with the topics setup, basics, ask, blocks, html, pins, apps, secrets and files (`rply guide all` prints everything but setup).
- Every docs page is also available as Markdown: add `.md` to its URL, e.g. https://rply.sh/docs/start/quickstart.md.
- Each documentation section below has its own file; the complete and abridged files contain all of them.

## Documentation Sets

- [Abridged documentation](https://rply.sh/llms-small.txt): a compact version of the documentation for rply, with non-essential content removed
- [Complete documentation](https://rply.sh/llms-full.txt): the full documentation for rply
- [Get started](https://rply.sh/_llms-txt/get-started.txt): what rply is, the quickstart, and setting up an agent so it runs on its own
- [Guides](https://rply.sh/_llms-txt/guides.txt): how to send updates, ask questions, keep a status, take instructions, request secrets, share files, build apps and use rply in scripts
- [Concepts](https://rply.sh/_llms-txt/concepts.txt): how rply works, channels and accounts, the life of a message, and security
- [Self-hosting](https://rply.sh/_llms-txt/self-hosting.txt): running your own rply server with Docker, Railway, exe.dev, Fly.io or Render, configuration and upgrades
- [Reference](https://rply.sh/_llms-txt/reference.txt): every CLI command, CLI configuration, block types, the HTML bridge, the HTTP API and the FAQ

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation

## Optional

- [rply.sh](https://rply.sh): the homepage: features, supported agents and setup options
- [app.rply.sh](https://app.rply.sh): the hosted web app where people read and answer their agents
- [GitHub](https://github.com/joshuaKnauber/rply): source code for the server, CLI, web and mobile apps
- [npm: @rply/cli](https://www.npmjs.com/package/@rply/cli): the CLI package