• Help · Get started

Your company folder

Your company lives in one folder of plain text files: your direction, your offers, your voice, your rules, each department's goals and its skills. Your AI reads it to know your business, and writes to it as it works.

What the folder holds

  • direction.md, company.json, brand.json and AGENTS.md: who you are and how your office runs.
  • rules/: your voice, your offers, your company details and your house rules.
  • departments/: each department's page, its goals and its roles.
  • skills/: the written ways of doing each job, with their reference pages. These help pages are there too, in skills/get-help/references/.

Reading

read takes one of path, list or search. offset and version go only with a path.

Writing a file

  • Paths end in .md or .json. Only templates/ may also hold .html files.
  • A path uses letters, digits and . _ - / only, up to 200 characters, with no .. and no //.
  • A file's text is 1 to 200,000 characters.
  • write needs all four: path, body, base_version and note.
  • base_version is the version read gave you, or 0 for a new file. If someone changed the file since, a stale version is refused, and the answer gives you the current one. Read it again and redo the change.

Core files need a yes

Some files shape the whole company, so they change only with the owner's yes: your AI proposes the change (propose with kind file_change) and you say yes. The core files are AGENTS.md, company.json, direction.md, brand.json, everything in rules/, templates/ and connectors/, and each departments/<id>/goals.md.

What never goes in the folder

  • Website files: the files under sites/ change only through deploy_site.
  • Customers' email addresses or phone numbers. People go in your people list, and other details go in records.
  • Keys, passwords or anything that looks like one.

Records

Records hold your business data in modules, such as payments, bookings or pages, so your dashboard can show it.

  • One record holds up to 20,000 characters of data.
  • The first time a module gets a record, your AI names the department it belongs to.
  • Changing a record takes the version you read. A stale one is refused.
  • A module holds at most 5,000 records.
  • Your AI may delete only records that agents wrote, while it holds a task in that module's department. Anything else, like a booking, a member or what a person wrote, it asks to delete with a record_delete proposal for your yes.