Skip to main content

CLI tool for CodeDD — run code audits from your terminal

Project description

CodeDD CLI

Run code audits from your terminal. The CodeDD CLI lets you define scope locally, run file-level and complexity analysis on your machine (using your own LLM API keys), and sync results to CodeDD for consolidation, recommendations, and dashboards.


What is CodeDD CLI?

CodeDD CLI is the official command-line interface for the CodeDD platform. You:

  • Define scope — Add one or more local Git repository roots to an audit.
  • Run analysis locally — File audits (LLM-based) and complexity metrics run on your machine; only metadata and results are sent to CodeDD.
  • Sync to CodeDD — Scope metadata, audit results, complexity data, dependencies, and architecture are submitted to CodeDD, where consolidation, dependency enrichment, security scoring, and recommendations run on the server.

Ideal for teams who want to keep source code local while still using CodeDD’s analytics, recommendations, and reporting.


Features

  • Scope management — Add/remove local directories, sync with CodeDD, detect changes and re-confirm scope (delta updates). Removing a repo from local scope also attempts a best-effort removal of the matching repository from CodeDD when the server still has it registered (with safe fallbacks if the API is unreachable or ambiguous).
  • Local file auditing — LLM-based file analysis using your Anthropic or OpenAI API keys; supports batching and progress feedback.
  • Complexity analysis — Cyclomatic complexity and Halstead metrics (Radon/Lizard) run locally and are submitted to CodeDD.
  • Dependency scanning — Local lockfile/manifest and import parsing; dependency data is sent to CodeDD for vulnerability and license analysis.
  • Architecture analysis — Local component/relationship extraction with optional LLM enhancement; additional local heuristics infer technologies, coupling, and communication-style signals (aligned with CodeDD payloads). Phase 3 synthesis and storage run on CodeDD.
  • Payment and budget — Pre-flight checks, LoC budget deduction, or Stripe checkout when additional payment is required.
  • Secure auth — CLI tokens stored in the OS credential store (Windows Credential Locker, macOS Keychain, Linux Secret Service).

Installation

Requirements

  • Python 3.10+ (3.10–3.13 supported; see pyproject.toml classifiers)
  • A CodeDD account and a CLI token (Account → CLI Access → Generate Token)

From source (development)

git clone https://gitlab.com/codedd1/codedd-cli
cd codedd-cli
pip install -e .

From PyPI

pip install codedd-cli

Verify:

codedd --version

Quick start (recommended workflow)

1. Authenticate once

Generate a CLI token at codedd.ai (Account -> CLI Access), then:

codedd auth login --token <your_token>

Or run codedd auth login and paste the token when prompted.

Optional sanity check:

codedd auth status

2. Select the active audit context

codedd audits list
codedd audits select

Choose a group audit (multiple repos) or a single audit (one repo). The selected audit becomes the active context used by all scope and audit commands.

3. Define local scope

Add local paths that correspond to the repositories in that audit (each path must be a Git repository root with commits):

codedd scope add /path/to/my-repo
codedd scope list
codedd scope confirm

scope confirm performs a metadata scan (paths, file types, LoC) and registers scope with CodeDD.
If files change later, codedd audit start auto-checks sync and prompts for re-confirmation when needed.

4. Configure LLM key(s)

Configure at least one provider key (used for local file-level auditing):

codedd config set-key anthropic
# or: codedd config set-key openai

Optional (recommended if both are configured):

codedd config provider both

5. Start the audit

codedd audit start

The CLI will:

  • Sync scope with CodeDD (and prompt to re-confirm if local files changed).
  • Run pre-flight checks (payment, LoC budget).
  • Optionally open payment in the browser or deduct from budget.
  • Fetch the plan, run local analysis, submit structured results, and trigger server-side post-processing.

Results and recommendations are available in the CodeDD dashboard; you can also run codedd audits list to see status.


Workflow overview

Use this exact order for a predictable run:

1. codedd auth login
2. codedd audits select
3. codedd scope add <repo-path> [more paths...]
4. codedd scope confirm
5. codedd config set-key <anthropic|openai>   # at least one
6. codedd audit start

What codedd audit start does, in order:

A. Auto-sync scope -> if changed, asks to re-confirm
B. Pre-flight on CodeDD -> checks status/payment/budget
C. Payment path -> budget deduction OR checkout flow
D. Local execution -> file audit (LLM), complexity, dependencies, git stats, architecture
E. Submission -> sends structured outputs to CodeDD (with retries on transient API errors)
F. Completion -> triggers server-side consolidation/recommendations

If you update files after confirming scope:

Run: codedd audit start
-> CLI detects drift
-> Re-confirm prompt appears
-> Continue with updated scope
Step Where it runs What happens
Scope add/confirm Local Scan dirs, count files/LoC; register or delta-update scope on CodeDD.
Pre-flight CodeDD Check payment, budget, status.
File audit Local LLM (Anthropic/OpenAI) analyses each file; results sent to CodeDD.
Complexity Local Radon/Lizard; metrics sent to CodeDD.
Dependencies Local + CodeDD Lockfiles/imports scanned locally; package/vuln data stored and enriched on CodeDD.
Git statistics Local + CodeDD Commit history and core repo stats collected locally and submitted; CodeDD can derive further timeline/churn views from that history.
Architecture Local + CodeDD Components/relations extracted locally; persisted and processed on CodeDD.
Recommendations CodeDD Consolidation, technical debt, security, licenses, etc.

Commands reference

Authentication

Command Description
codedd auth login Log in with a CLI token (prompt or --token)
codedd auth logout Clear stored credentials
codedd auth status Show current account and token state

Audits

Command Description
codedd audits list List audits (--type single|group, --limit, --page)
codedd audits select [uuid] Set active audit (interactive if UUID omitted)

Scope

Command Description
codedd scope add <path> [path ...] Add Git repository root(s) to the active audit’s scope
codedd scope remove <n> Remove directory by list number
codedd scope list List directories in scope
codedd scope clear Remove all directories from scope
codedd scope status Show scope and sync state per directory
codedd scope confirm Scan, preview, and register scope with CodeDD
codedd scope sync Compare local vs CodeDD and show changes

Audit execution

Command Description
codedd audit start Sync scope (if needed), pre-flight, pay/budget, then run full local audit and submit to CodeDD. Use --skip-sync to skip scope sync; --yes to auto-confirm; --show for one-shot transparency summary; --show-interactive for per-request confirmations (debug); --show-force-interactive to override large-audit guardrails; --debug-llm for LLM debug output; --debug-llm-full-prompt to include the full proprietary system prompt in that output (sensitive).

Configuration

Command Description
codedd config show Show current config (API URL, active audit, scope, etc.)
codedd config set <key> <value> Set a config value
codedd config set-key [anthropic|openai] Store an LLM API key in the OS keychain
codedd config show-keys List which providers have keys configured (not the keys themselves)
codedd config remove-key <anthropic|openai> Remove a stored LLM API key from keychain
codedd config provider [anthropic|openai|both] Set preferred LLM provider
codedd config concurrency <n> Set max concurrent LLM requests (default 6)

Configuration

  • Config file: ~/.codedd/config.toml (TOML). Stores API URL, active audit, scope directories, LLM provider, concurrency. Permissions are restricted to the owner (Unix).
  • Secrets: The CLI token and LLM API keys are stored in the system keychain (Windows Credential Locker, macOS Keychain, Linux Secret Service), not in the config file.

Optional [audit] keys (defaults shown) tune how long the CLI waits after opening a payment browser flow:

  • payment_poll_interval_seconds (default 5)
  • payment_poll_max_wait_seconds (default 600)

Environment variables

Variable Purpose
CODEDD_API_TOKEN Override the stored CLI token (e.g. for CI)

Security

  • CLI tokens and LLM keys are stored in the OS credential store, not in plaintext on disk.
  • TLS certificate verification is always enabled for API requests.
  • Config file and ~/.codedd directory use owner-only permissions where supported.
  • Tokens expire after 90 days (server-configurable); re-generate from the CodeDD dashboard when needed.

Development

pip install -e .
pip install pytest pytest-httpx pytest-mock ruff
pytest
ruff check .

License

MIT License — see LICENSE.


Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codedd_cli-0.1.5.tar.gz (204.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codedd_cli-0.1.5-py3-none-any.whl (227.8 kB view details)

Uploaded Python 3

File details

Details for the file codedd_cli-0.1.5.tar.gz.

File metadata

  • Download URL: codedd_cli-0.1.5.tar.gz
  • Upload date:
  • Size: 204.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for codedd_cli-0.1.5.tar.gz
Algorithm Hash digest
SHA256 ee086b6321ad65eafb466f26a5138a45e560265bfcfcdfd34c941f0525b0c0c4
MD5 7eda85b9289b7e0e4f531f791a350cfe
BLAKE2b-256 430e82f65a4f20a38fbfe1987d9af8d9c3cd7d79e1e388c310db4f1f1e50879c

See more details on using hashes here.

File details

Details for the file codedd_cli-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: codedd_cli-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 227.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for codedd_cli-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4a6ac13ea4a5ec390bd7d663224ec787eac9509cbf9846fd65178d64f67f3484
MD5 3f9197755bb4b8bf9c671e46f0c20dc1
BLAKE2b-256 517aa6ad206149c495a3fd8cf1cbcf777f431490e4a79da6a91a36ac5ad276d0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page