Skip to content

docs: README quick start + auto-detection updates - #102

Merged
FIERsity merged 2 commits into
mainfrom
docs/quick-start
Aug 6, 2026
Merged

docs: README quick start + auto-detection updates#102
FIERsity merged 2 commits into
mainfrom
docs/quick-start

Conversation

@FIERsity

@FIERsity FIERsity commented Aug 6, 2026

Copy link
Copy Markdown
Owner

README onboarding fix from the product review: a 5-minute quick start right after Install (auto-detected format, real output, scenario table), updated common-flags table (-f omits to auto-detect, positional PATH), audit section notes auto-detection, test count 112 → 145.

Docs only — no code.

🤖 Generated with Claude Code

FIERsity and others added 2 commits August 7, 2026 01:08
`envorigin audit` / `scan` / `explain` / `graph` now work in any repo
without flags: the project type is detected (compose → actions →
gitlab → circleci → dotenv, the same precedence the GitHub Action
wrapper uses) and the command dispatches to the right backend, with
the detected file named in the output. Backend-prefixed commands stay
for power users and CI pinning.

Also:
- positional path argument on the top-level commands: a config file
  or a directory to detect in (`envorigin scan ./dir`)
- redaction hint: human output appends "pass --show-values to reveal"
  when values were hidden
- friendly error when no compose/CI config is found in the target dir

Tests: 9 new integration tests (auto-detection per backend, bare-dotenv
directory, positional paths, empty-directory error, redaction hint).
145 total, all green; clippy -D warnings and fmt clean.

Co-Authored-By: Claude <noreply@anthropic.com>
- 5-minute quick start after Install: install → cd → envorigin audit
  (format auto-detected), a real output sample, and a scenario table
  (.env mystery → explain, CI gate → audit --fail-on, team rules →
  init, drift → diff)
- common-flags table: -f now omits to auto-detect; positional PATH
  documented
- audit section notes top-level auto-detection; prefixed variants pin
- test count 112 → 145

Co-Authored-By: Claude <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@FIERsity, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 47 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: b7143858-a0d8-4936-9edc-405a535a7b58

📥 Commits

Reviewing files that changed from the base of the PR and between 4d58a9e and aa90ca5.

📒 Files selected for processing (7)
  • README.md
  • src/cli.rs
  • src/detect.rs
  • src/lib.rs
  • src/main.rs
  • src/model.rs
  • tests/cli.rs

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.

@FIERsity
FIERsity merged commit 81962f8 into main Aug 6, 2026
2 of 4 checks passed
@FIERsity
FIERsity deleted the docs/quick-start branch August 6, 2026 20:20
FIERsity added a commit that referenced this pull request Aug 6, 2026
CHANGELOG [1.12.0]: unified entry (auto-detection), positional path
args, redaction hint. post-release-plan: UX release section marked done
(pulled into 1.12.0, PR #101); docs section done (PR #102, metadata
needed no change); note the CI rerun pending GitHub Actions recovery.

Co-authored-by: Claude <noreply@anthropic.com>
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