Skip to content

Usage

Terminal window
codeshare --full
Terminal window
codeshare --api-only --path src
Terminal window
codeshare --diff --path src
Terminal window
codeshare --diff --diff-api-only --path src

Restrict to code files only:

Terminal window
codeshare --code-only

Exclude data/ directories:

Terminal window
codeshare --exclude-data

Ignore lockfiles:

Terminal window
codeshare --ignore-lockfiles

Write to stdout only:

Terminal window
codeshare --stdout --no-artifact

Include imports in API-only mode:

Terminal window
codeshare --api-only --imports-included

Include multiple paths:

Terminal window
codeshare --paths src/module_a src/module_b

Compare with an older counting snapshot:

Terminal window
codeshare --diff --steps-back 3

Compare with one exact snapshot id:

Terminal window
codeshare --diff --snapshot-id SNAPSHOT_ID

Render read-only:

Terminal window
codeshare --full --read-only

Explicitly provided paths may also live outside the current repository.

That is useful when assembling one share from multiple related repos, for example a code repo plus a docs repo.

Use .codeignore to exclude things like docs, logs, generated files, or lockfiles when desired.