Documentation

How Known works, from sign-in to the API.

Three guides: getting a workspace going, running the CLI, and reading the API. Sections marked in progress are being written.

Getting started

Sign in, make an organization, connect a source.

docs · start
  • sign inSign in with your work account. Choose or create the organization the record belongs to.Written
  • connectFrom Config, add Slack or GitHub. Slack asks which channels to route; GitHub installs on the repositories you pick.Written
  • first pageOpen the wiki, write the first page, and watch the change log and history fill as others edit.In progress

CLI

known: one sign-in per organization, no global state.

docs · cli
  • loginknown login opens the browser, you choose the organization, and the session is filed under its slug.Written
  • commandsEvery scoped command names its organization first: known acme ping. What a command targets is visible in the command.Written
  • agentsHow Claude Code, Codex, Grok Build, and Pi sessions use the CLI to read and write the wiki as you.In progress

API

JSON-RPC over one endpoint, discoverable from the root.

docs · api
  • discoveryAn app your organization registers signs people in with Known and reads the wikis attached to it. GET the host document for the sign-in, the method list, and parameters; a wiki’s own document, with its record schemas, comes with a token.Live
  • methodsThe wiki, chat, activity, and connection method families, with their refusal codes.In progress
API discovery document: https://rpc.known.info/rpc