R
RunScribe
FeaturesHow It WorksPricingDocs
R
RunScribe

Automated documentation and codebase audits for modern development teams.

Product

  • Features
  • Pricing
  • Docs

Company

  • About
  • Careers
  • Contact

Legal

  • Privacy
  • Terms

RunScribe — Documentation that runs itself. © 2026

PrivacyTerms
IntroductionQuickstartInstallation
Connect RepositoryGenerate DocumentationCustomizationCI/CD IntegrationNew
Getting StartedQuickstart
5 min read

Quickstart Guide

Get up and running with RunScribe in under 5 minutes. Connect your repository and generate your first documentation.

Prerequisites

  • A GitHub, GitLab, or Bitbucket account
  • A repository with code you want to document
  • A RunScribe account (free tier available)

Getting Started

01

Connect your repository

Link your GitHub, GitLab, or Bitbucket repository to RunScribe. We support both public and private repositories.

Terminal
npx runscribe init
02

Configure your preferences

Choose what types of documentation you want to generate: file-level, architecture, API docs, or all of the above.

03

Generate documentation

RunScribe analyzes your codebase and generates comprehensive, accurate documentation automatically.

Next Steps

Connect Repository Guide

Learn more about repository configuration options.

Customization Guide

Customize how RunScribe generates your documentation.