Oysterun Docs
Find documentation by task.
Start with Getting Started for your first journey; for a specific task, search the current guides or browse the task groups below.
Host and connection
- Sign in to an Oysterun Host and confirm the connectionOpen the exact current Host URL in a private browser profile, use its password-only flow, recover safely, and confirm Sessions is Connected through the expected transport.how-to
- Set up and understand your Oysterun HostComplete the current supported Host setup, then use visible product state to distinguish the Host, a Session, its AgentFolder, its Agent ID, and a Website shared link.tutorial
Sessions and providers
- Choose a Session folder and control which settings are savedChoose a focused Start Folder, preserve your setup draft when canceling or confirming the Folder Picker, and decide whether Session settings apply once or persist with the project.how-to
- Choose and recover an Oysterun providerChoose Claude or Codex in Session Setup, separate dashboard access from provider login, and follow one bounded recovery path when its command or login is unavailable.troubleshooting
- How to tell whether an Oysterun agent is working or idleSend one safe message from the Sessions page and distinguish available, occupied, working, terminal, and unknown states without duplicate work.how-to
Chat, messages, and files
- How to read large Oysterun Tool resultsDistinguish a long Tool run from one oversized result, then use View details, paging, and bounded content to read what is currently available.how-to
- How to send images and media in OysterunSend one or several media items once from a Session chat, then check order, the shared caption, and the difference between original and bounded display bytes.how-to
Recovery and troubleshooting
- Restore work safely after an Oysterun Host restartRestart only with current permission for the exact Host and action, then verify the actual returned state of Sessions, conversation history, interrupted work, and Loops.troubleshooting
- Recover safely from an Oysterun Host runtime errorPreserve a read-only Explorer runtime error, use visible Back once, and finish Recovered when the same Session chat returns with expected history and a usable composer.troubleshooting
CLI and Skills
- How to use the Oysterun CLI safelyFind supported operations from CLI help, distinguish reads from ordinary and protected mutations, and use dry-run and confirmation boundaries correctly.reference
- How to install and use an Oysterun SkillFind, install or update, verify, and safely use an eligible Oysterun Skill in a Claude or Codex Session.how-to