Privacy and file exclusions

The CLI packages files from your selected folder and uploads the snapshot to DocuWriter. Review the folder and its contents before confirming the workflow.

What the snapshot includes

A generation snapshot can include tracked files, local edits, and untracked files that remain after file exclusions. It reads files from disk, so the uploaded snapshot can differ from the latest Git commit.

A documentation import includes the selected .md and .markdown files plus eligible local images referenced by those pages. It does not upload the entire codebase for AI generation.

Use a specific folder when appropriate:

npx docuwriter --cwd ./packages/api

The CLI does not automatically synchronize later local changes. Each upload represents a point in time.

How files are excluded

The CLI applies:

  • Applicable .gitignore rules, including rules in ancestor directories and nested folders.
  • Built-in exclusions for version-control metadata, dependencies, common credential files, and other sensitive file types.
  • Additional exclusion patterns supplied by DocuWriter.

Built-in exclusions include .git/, node_modules/, vendor/, virtual environments, .env and .env.*, common private key and certificate files, .npmrc, .netrc, .git-credentials, common cloud credential folders, and Terraform state files. Symlinks are not followed or uploaded.

These exclusions are pattern based. They do not guarantee detection of every secret in arbitrary source files. Check the selected folder and use .gitignore rules to exclude files you do not want uploaded.

A selected folder excluded by an applicable .gitignore rule cannot be uploaded. If no eligible files remain, the CLI stops before uploading.

Local session and upload state

The CLI saves its authenticated session and, when needed, a pending upload snapshot in an operating-system application data directory. It uses restrictive local directory and file permissions.

After DocuWriter accepts an upload, the CLI removes its pending local snapshot. A network failure can leave the approved snapshot available for recovery on a later run. See Troubleshooting for the difference between recovering an interruption and explicitly cancelling an upload.

To revoke the saved CLI session:

npx docuwriter logout

Usage analytics

After sign-in, the CLI collects usage analytics to help improve the experience. These can include submitted setup answers such as company/project, sector, documentation goal, audience, and timezone. No anonymous CLI analytics are collected.

Disable analytics:

npx docuwriter analytics off

Check or re-enable the saved preference:

npx docuwriter analytics status
npx docuwriter analytics on

Setting DOCUWRITER_TELEMETRY_DISABLED=1 disables analytics for that process, even if the saved preference is on.

Related: Command reference and Import existing documentation.

Updated