ResearchOS
/Wiki

Read this first

ResearchOS brings projects, experiments, notes, methods, sequences, data analysis, and figures into one workspace. Start with the desktop app and use this wiki when you need help with a particular task.

Start with your notebook

  1. Download ResearchOS for your computer and open the app. You can explore sample data before working with your own notebook.
  2. Follow the setup shown in the app. Sign in when prompted, then create or open a notebook. Desktop setup can use the app's default folder or let you choose another location. See Accounts and plans.
  3. Keep track of the folder you connect. Your local notebook records and attachments are saved there. If it contains more than one local user, select the user whose work you want to open.
  4. Open the Workbench to create a project, add an experiment, or write a note. Use the guides for the tools you need rather than reading every setup page in order.

The website provides downloads, documentation, account services, and public research pages. Open your notebook in the desktop app.

Where your data goes

Your notebook is local first. Connecting a folder gives the app access to its files. That is different from enabling a cloud service, and it does not mean every feature operates only on your computer.

  • Local work. Notebook records, notes, and attachments are stored in your connected folder. Local editing can continue offline when the app and needed files are available. Sign-in and network features need a connection.
  • Sharing and collaboration. Sending work or enabling supported live collaboration transfers encrypted content through ResearchOS services. Those services may retain encrypted bundles or snapshots for delivery and recovery. See Sharing and permissions.
  • Backups and folder sync. A configured backup copies data to its selected destination. A folder inside OneDrive, Dropbox, or another sync service can also be uploaded by that service. Check your backup status and the provider's settings.
  • AI assistance. Using BeakerBot can send your messages, supplied attachments, and relevant research context to an AI service. Review what you include and the AI settings before using it with sensitive work.
  • Publishing and account services. Published research pages and uploaded website files are hosted online for their intended audience. Sign-in, profiles, and billing also use server-side services. Publishing is a separate action from saving a local note.

Accounts and plans

The local app is free and open source. Free, Solo, Lab, and Department describe different levels of cloud service. Cloud services are free during beta while billing is off, and optional AI has separate billing controls. See Pricing for the current offer and Accounts and plans for sign-in and lab membership.

Working with a lab

Projects organize experiments and related work. The Workbench brings together your projects, experiments, notes, and lists. Lab heads also have the Lab lens of People, Lab data, and Supplies for following mentorship, shared writeups, inventory, and funding. A lab role and access to a particular record are separate things, so check sharing permissions when inviting others.

If your team uses a shared folder through its own cloud provider, read Shared Lab Accounts. Keep the folder downloaded locally so the app can read and write its files. Shared-folder access through your provider is distinct from ResearchOS live collaboration.

Find help when you need it

  • Use the wiki search to find a tool or action by name.
  • Browse a sidebar category for related guides.
  • Use the app's help button to open documentation for the current surface.

Settings are available from your profile menu. Review integrations, backups, and AI there as you set up your workflow. If an action is broken or unclear, use Feedback to report what you were trying to do.