Skip to documentation
Documentation
Documentation
OverviewInstallationQuickstartYour first dayYou were sent a linkWorking with a customerConfigurationTroubleshootingFAQGlossary

Usage

Terminal interfaceCLIStatuslineDashboardAnalytics

Collaborate

DocumentsLessonsSession sharingPicking up tomorrow and handing work overFrom your phoneSession linksSession messagingAsksAsks privacy fact sheetFeedbackEmail from crewkitBlueprintsAgent identitiesMCP server

Configure

AgentsSkillsSkill and agent security scanningRulesCommandsInheritancePlaybooksExperimentsHooksCapture modesSensitive sessionsData residencyTeamSettings mapIntegrations

Workspaces

WorkspacesSet up a workspaceFix a ticket end to endShip a feature with approvalHand off work and set agent settings

API Reference

API OverviewAuthenticationSessions APIResources APIOrganizations APIProjects APIPlaybooks APIExperiments API
Need a hand?Find an answer in troubleshooting.
Loading docs…
CREWKIT / DOCUMENTATION

Your first day

Where to start in crewkit for a developer, a manager, an admin, and someone who was sent a link.

Pick the path that matches why you are here. Each one takes a few minutes and ends where you can see crewkit working.


A developer

  1. Install the CLI.
  2. In a repository of one of your organization's projects, run crewkit code. If you are not signed in, crewkit opens your browser to sign in and the CLI picks up the token.
  3. The first time, crewkit shows its acceptable-use policy and asks you to accept it. A launch that has not accepted it stops there.
  4. crewkit matches your git remote to a project, syncs your team's agents, skills, commands and playbooks into .claude/, and launches Claude Code.
  5. When the session ends, open the dashboard: your conversation is in that project's Conversations, with its cost, tokens, tools and summary.

The Quickstart has the detail of each step.


A manager

  1. Invite your team from Team, choosing each person's role. A Developer runs sessions; a Viewer reads. The roles table lists what each role may do and which conversations it reads.
  2. Each invited developer follows the developer path above. Their conversations appear in the project they ran them in.
  3. Cost and usage are under Analytics, for the organization and per project. See Analytics.
  4. How much of each session crewkit collects is your organization's capture mode. An organization that never set it is on structured, which stores prompt and response text. An org admin changes it.

An admin

  1. Choose the capture mode and the retention term in Settings → Organization → Privacy & Telemetry. Both apply to every project in the organization. See Capture modes.
  2. Connect your tools under Settings → Integrations.
  3. Set up single sign-on and SCIM, if your organization uses them. See Single sign-on and SCIM.
  4. Check who has which role on Team. See Team.

Someone sent a link

Someone shared a crewkit page with you: a set of questions to answer, a conversation to read, or a feedback panel in an app. Sent a link says, for each, what it is, what you can do with it, who reads what you send and how long it is kept.

Quickstart

Go from install to your first tracked session in under a minute.

You were sent a link

For someone with no crewkit account who opened a crewkit link, what the page is, what you can do there, who reads what you send, and how to erase it.

On this page

A developerA managerAn adminSomeone sent a link