Skip to content

docs(ocm): refresh env and CLI guides and redact internal settings secrets - #398

Merged
chriswritescode-dev merged 1 commit into
mainfrom
docs/refresh-env-and-ocm-guides
Oct 8, 2026
Merged

chriswritescode-dev merged 1 commit into
mainfrom
docs/refresh-env-and-ocm-guides

Conversation

@chriswritescode-dev

Copy link
Copy Markdown
Owner

Summary

Refreshes the environment, contribution, and ocm CLI documentation, and redacts stored credentials from the internal settings API.

  • .env.example documents previously undocumented options (OPENCODE_HEALTH_*, OPENCODE_BIN, REPO_BROWSE_ROOT, PREVIEW_PORT) and corrects PASSKEY_ORIGIN for Vite dev, the sandbox image digest pin, and the SANDBOX_EXEC_USER default.
  • CONTRIBUTING.md adds type-checking and commit-message conventions; README.md refreshes the feature list and the ocm CLI description.
  • ocm-cli/README.md and ocm-cli/bin/ocm.ts document ocm login, the install layout, --version/--help and aliases, push/pull safety prompts, the <host> · <repo> indicator, and the /ocm-goal and /ocm-multirun flows.
  • The internal settings routes replace stored credentials (git tokens, SSH keys and passphrases, TTS/STT API keys, server env var values, last known good config) with <redacted>; empty values stay empty so a caller can still tell whether a credential is set. Applies to GET and PATCH.
  • scripts/setup-dev.sh no longer creates the unused workspace/config directory.

Type of Change

  • Bug fix
  • New feature
  • Refactor
  • Documentation

Checklist

  • Code follows project style (no comments, named imports)
  • TypeScript types are properly defined
  • Tests added/updated (80% coverage target)
  • pnpm lint passes locally
  • pnpm typecheck passes locally

Backend typecheck is clean and pnpm lint reports 0 errors (41 pre-existing no-explicit-any warnings). backend/test/routes/internal-settings.test.ts passes (21 tests), including a new case asserting GET redacts stored credentials, keeps empty ones empty, and leaks no secrets; the PATCH test now asserts the response is redacted while the stored value is unchanged.

@chriswritescode-dev
chriswritescode-dev merged commit 22fd909 into main Oct 8, 2026
1 of 2 checks passed
@coderabbitai

coderabbitai Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: f8fce364-6f36-4e7d-9a17-b788523e649d
📥 Commits

Reviewing files that changed from the base of the PR and between 4553af4 and 4b6df6c.

📒 Files selected for processing (9)
  • .env.example
  • CONTRIBUTING.md
  • README.md
  • backend/src/routes/internal/settings.ts
  • backend/src/services/assistant-mode.ts
  • backend/test/routes/internal-settings.test.ts
  • ocm-cli/README.md
  • ocm-cli/bin/ocm.ts
  • scripts/setup-dev.sh
 ________________________________________
< Ship it? Sure-after we unship the bug. >
 ----------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant