UptoDocs LogoUptoDocs

Commands

UptoDocs supports explicit commands via GitHub issue comments. Commands give you fine-grained control when automation is not enough.


/uptodocs bootstrap

/uptodocs bootstrap

Initializes UptoDocs in your repository and generates initial documentation for existing code.

Use when:

  • Setting up UptoDocs for the first time
  • You want to generate baseline documentation

Plan: Free, Pro, Enterprise


/uptodocs latest

/uptodocs latest

Manually triggers documentation updates for the latest commit on the default branch.

Use when:

  • Automatic detection was skipped
  • You want to force an update
  • Testing the integration

Plan: Free, Pro, Enterprise


/uptodocs [commit-sha]

/uptodocs 5f2a1b3

Manually triggers documentation updates for a specific commit.

Use when:

  • You want to document a specific commit
  • Reprocessing historical changes
  • Testing against a particular code state

Plan: Free, Pro, Enterprise


/uptodocs drift

/uptodocs drift

Scans your entire repository for documentation drift using advanced AI:

  • Docs referencing removed or changed code
  • Public APIs missing documentation
  • Outdated examples and references

Results are reported in the issue thread.

Use when:

  • Auditing documentation quality
  • After major refactors
  • Preparing for releases

Plan: Enterprise only


/uptodocs coverage

/uptodocs coverage

Generates a comprehensive summary of your documentation coverage across the codebase.

Use when:

  • Assessing documentation completeness
  • Planning documentation work
  • Reporting on documentation metrics

Plan: Pro, Enterprise


/uptodocs billing

/uptodocs billing

Shows your current subscription plan, status, and repository information.

Use when:

  • Checking your plan details
  • Verifying subscription status
  • Before using premium features

Plan: All plans


Subscription Management Commands

/uptodocs subscription add-repo [owner/repo]

/uptodocs subscription add-repo owner/my-new-project

Adds another repository to your subscription (if slots are available).

Requirements:

  • Available slots in your subscription
  • UptoDocs installed on target repository
  • Must be run from the repository being added

Plan: Pro, Enterprise


/uptodocs subscription remove-repo [owner/repo]

/uptodocs subscription remove-repo owner/old-project

Removes a repository from your subscription and downgrades it to Free tier.

Requirements:

  • Must be run from the repository being removed
  • Frees up a subscription slot

Plan: Pro, Enterprise


/uptodocs subscription change-repo [owner/repo]

/uptodocs subscription change-repo owner/different-repo

Shows instructions for changing the repository associated with your subscription. For safety, this requires removing the old repository first, then adding the new one.

Plan: Pro, Enterprise


/uptodocs help

/uptodocs help

Displays a summary of all available commands with brief descriptions.

Plan: All plans


How to Use Commands

  1. Navigate to any issue or PR in your repository
  2. Post a comment with the command
  3. Wait for acknowledgment — UptoDocs will react with an emoji
  4. View results in follow-up comments

Permissions Required for Commands

Commands require:

  • UptoDocs GitHub App installed on the repository
  • Write access to the repository
  • Ability to comment on issues/PRs

Commands from unauthorized users are ignored.


Command Safety

  • Commands never auto-merge changes
  • All documentation updates create reviewable PRs
  • Invalid commands are safely ignored
  • Rate limits apply to prevent abuse

Legacy Command Support

Note: /docify commands are automatically converted to /uptodocs for backward compatibility.


Summary

Commands let you:

  • Manually trigger documentation updates
  • Manage subscriptions across repositories
  • Run advanced AI-powered features
  • Preview and audit documentation quality

They are optional — automatic triggers handle most workflows, but commands give you explicit control when needed.

On this page