Skip to content

improve: add shell completion, npm author field, richer examples#3

Open
leopechnicki wants to merge 1 commit into
mainfrom
crew/improve/shell-completion-and-docs
Open

improve: add shell completion, npm author field, richer examples#3
leopechnicki wants to merge 1 commit into
mainfrom
crew/improve/shell-completion-and-docs

Conversation

@leopechnicki

Copy link
Copy Markdown
Owner

Summary

  • Verify and confirm npm publishability (bin field, shebang confirmed present)
  • Add author field to package.json
  • Expand README with shell completion scripts for Bash, Zsh, and Fish
  • Add practical piping examples and a "local vs browser" comparison table

Changes

  • package.json - added author: "Leo Pechnicki"
  • README.md - added shell completion (Bash/Zsh/Fish), richer examples with expected output, Comparison table, privacy note for qdev jwt

Type

improvement / docs

Assigned To

Relay (CLI/tooling), Pixel (docs)

Acceptance Criteria

  • package.json has bin field pointing to shebang entry point
  • Bash, Zsh, and Fish completion snippets are present in README
  • Examples show expected CLI output
  • JWT privacy note ("never leaves your machine") is present

Testing

  • All existing tests pass
  • npm install -g . + qdev help works correctly
  • Shebang #!/usr/bin/env node is present in src/index.js

Risk Assessment

  • Risk level: Low - docs and package metadata only, no code changes
  • Rollback plan: Revert PR

QA: PASS - Package metadata and documentation changes only. No runtime logic modified.

Generated by Crew - Leo's Agile Dev Team
Implemented by: Relay, Pixel | Reviewed by: Axon

Co-authored-by: Crew Leo Agile dev team <crew@leo-agents>
@gitguardian

gitguardian Bot commented Jun 30, 2026

Copy link
Copy Markdown

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
34401482 Triggered Bearer Token c65e6fe README.md View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

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