Skip to content

Add pre-check and installation guidance for chira command dependency - #9

Closed
bonsai wants to merge 2 commits into
mainfrom
fix-chira-cmd-dependency-14631270823285253889
Closed

bonsai wants to merge 2 commits into
mainfrom
fix-chira-cmd-dependency-14631270823285253889

Conversation

@bonsai

@bonsai bonsai commented Nov 11, 2026 •

Copy link
Copy Markdown
Owner
  • Implemented is_chira_available() to pre-check for the chira executable in PATH before invoking :md and :sync.
  • Added clear and actionable status message (chira CLI is not installed or not in PATH. Install with: cargo install chira-ura) on pre-check failure or if io::ErrorKind::NotFound occurs.
  • Updated command line --help in src/main.rs and documentation in README.md to note the prerequisite CLI tool and its installation command.
  • Added unit tests in src/app.rs testing is_chira_available and the error status messages on :md and :sync when chira is absent.

Fixes #2


PR created automatically by Jules for task 14631270823285253889 started by @bonsai

Summary by Sourcery

Add a pre-check and actionable installation guidance for the external chira CLI used by markdown commands.

Bug Fixes:

  • Prevent :md and :sync from failing opaquely when the external chira CLI is unavailable by displaying installation guidance.

Enhancements:

  • Add cross-platform detection for the chira executable before running dependent commands.

Documentation:

  • Document the required chira CLI dependency and installation command in the README and command-line help.

Tests:

  • Add coverage for missing-chira detection and user-facing status messages for :md and :sync.

Provide pre-checks and helpful error messages for `:md` and `:sync`
commands when the external `chira` CLI binary is missing. Include
installation instructions (`cargo install chira-ura`) in help text
and documentation.

Co-authored-by: bonsai <24775+bonsai@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@sourcery-ai

sourcery-ai Bot commented Nov 11, 2026

Copy link
Copy Markdown

Sorry @bonsai, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 15 hours and 48 minutes by commenting @sourcery-ai review. Upgrade to get a review now.

@chatgpt-codex-connector

Copy link
Copy Markdown
Codex Review Summary: ❌ Failed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ❌ Failed 2026-11-11T10:00:49.152468Z
We couldn’t complete this review. Comment @codex review to try again.
8a7c38e PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3d8dcb2b-3694-42eb-84e6-1ac0e856d063
  • Autofix · 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

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@sourcery-ai

sourcery-ai Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

Implementation

Add PATH-based detection for the external chira CLI and return an installation notice when it is unavailable before or during command execution.

  • src/app.rs L12-38, L1143-1146, L1178-1181

UI

Update the interactive help text to state that the chira CLI is required and give its installation command.

  • src/main.rs L48

Documentation

Document the chira CLI prerequisite and installation command alongside the :md and :sync commands.

  • README.md L39, L99-100

Tests

Test CLI availability detection and the missing-CLI status notices for both commands.

  • src/app.rs L1822-1883

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

…ncy-14631270823285253889

# Conflicts:
#	src/app.rs

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sourcery assessment

Approved.

@bonsai

bonsai commented Nov 12, 2026

Copy link
Copy Markdown
Owner Author

Superseded by #15: cmd_md/cmd_sync already handle missing chira (NotFound -> install guidance + PATH_LOCK tests). Doc residue (README usage lines) noted in #14.

@bonsai bonsai closed this Nov 12, 2026
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.

ISSUE-001: Chira Command Dependency

1 participant