Skip to content

Command-line toolkit that blends hand-crafted workflows with OpenAPI-generated commands for GitHub.

License

Notifications You must be signed in to change notification settings

toneflix/grithub

Repository files navigation

Grithub

npm version License CI Deploy Docs

Command-line toolkit for GitHub: authenticate once, set a repo, and work with issues in bulk or interactively. Includes a generator that syncs the CLI surface with the GitHub OpenAPI spec.

Install

pnpm add -g @toneflix/grithub
# or npm i -g @toneflix/grithub

Quick start

  • Login: grithub login (opens browser flow, stores token locally)
  • Set default repo: grithub set-repo owner/name
  • Inspect info: grithub info
  • Work with issues (interactive): grithub issues to list, view, close/reopen, edit, or delete
  • Seed/update/delete issues in bulk: grithub issues:seed, grithub issues:update, grithub issues:delete

Generated API commands (dynamic)

The CLI can generate commands directly from the GitHub OpenAPI spec. This keeps available commands and params in sync with GitHub without hand-coding.

  1. Generate commands (writes .grithub/apis.generated.js):
    grithub generate:apis
  2. Use generated commands (examples):
    • Create issue: grithub issues:create --title "Bug" --owner org --repo repo
    • List issues: grithub issues:list-for-repo --owner org --repo repo
    • Get single issue: grithub issues:get --owner org --repo repo --issue_number 123

Notes

  • The generator runs once and the CLI will auto-load .grithub/apis.generated.js on subsequent runs.
  • Only the command usage matters; you do not need to edit the generated file by hand.

Contributing

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Development Guidelines

  • Write TypeScript with proper type definitions
  • Follow existing code style
  • Add tests for new features
  • Update documentation for API changes
  • Ensure all tests pass before submitting PR

License

This project is licensed under the ISC License - see the LICENSE file for details.

Support

Acknowledgments


© Copyright 2026 - ToneFlix Technologies Limited

About

Command-line toolkit that blends hand-crafted workflows with OpenAPI-generated commands for GitHub.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •