Import a repository
Import a repository. See your codebase documented.
Paste one repository and ShipDocs writes the documentation from the code itself: an overview of how the project fits together, then one Markdown page per component, all cited from real file paths. You do not need a card, an empty docs folder or a prepared prompt to see the output - the first repository is a free preview, and the docs appear in minutes. If the result is useful, the 3-day Advanced trial keeps the workspace, cited chat and MCP access going.
How do I import a repository into ShipDocs?
Importing is one paste or one provider connection, and the indexing pipeline does the rest. ShipDocs reads the repository, plans the documentation modules from the directory structure and source files, then writes each page from what the code actually does - so the result matches the repository rather than a generic template.
- 1
Paste a repository URL
Drop in the address of any public GitHub, GitLab or Bitbucket repository. For private code, connect the provider once and pick a repo from the list instead.
- 2
ShipDocs reads the code and writes the docs
The indexer plans the modules, then writes an overview plus one Markdown page per component. Every answer cites the real files it came from.
- 3
Read the overview, then decide
Your first preview repository is free and needs no card. Keep the docs, cited chat and MCP access by starting the 3-day Advanced trial.
Which repositories can I import?
GitHub, GitLab and Bitbucket are supported for both public and private repositories, and any codebase can arrive as a ZIP or through the CLI. Monorepos, polyrepos, Bun, Node, Python, Go, Rust and mixed stacks all work: the indexer detects the components itself and writes module-level docs automatically.
- GitHubPublic URLs or a private connection
- GitLabPublic URLs or a private connection
- BitbucketPublic URLs or a private connection
- ZIP uploadAny codebase, no git host needed
- CLI pushIndex a local folder from the terminal
What does the free preview include?
The preview is the documentation run itself: one repository, written from your code, readable before any payment. It is limited to one repository per account and one import per network per day, which keeps the free run available for real teams instead of bots. The 3-day Advanced trial that follows unlocks the full workspace: cited chat over the repository, auto-sync when code changes, repo insights, and the MCP endpoint that Cursor and Claude Code connect to.
- Overview page plus one Markdown page per detected component
- Docs are generated from the code, with real file citations
- One free preview repository per account, no card required
- Export the Markdown at any time - you own the output
Is my code safe?
Code is encrypted at rest with AES-256-GCM, sent to model providers under zero-retention API terms and never used to train models. Each project keeps its own key, and generated documentation is standard Markdown that stays exportable. The full detail is on the security page.
Private repositories are a first-class use case, not an afterthought: connect GitHub, GitLab or Bitbucket once and pick from your own repos.
Frequently asked questions
Do I need a credit card to import a repository?
- No. The card-free preview imports one repository and writes the documentation so you can read the overview first. The 3-day Advanced trial starts only when you choose to continue and needs no credit card either, and there is no free plan after the trial ends.
Which repositories can I import?
- Public repositories from GitHub, GitLab or Bitbucket can be pasted as a URL. Private repositories are imported after connecting the provider once. Any codebase can also arrive as a ZIP upload or through the shipdocs CLI, so monorepos and mixed stacks are supported.
How long does the first documentation take?
- The overview is usually readable within a couple of minutes; a full set of per-component pages takes longer on large repositories. The docs are written from the code itself, not from a prompt you have to prepare, so there is nothing to configure first.
Is my code used to train AI models?
- No. Code is sent to model providers under zero-retention API terms, stored encrypted with AES-256-GCM per project, and never used for training. Generated docs are standard Markdown you can export at any time.
By The ShipDocs team · Reviewed
