@toneflix/grithub 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +15 -0
- package/README.md +82 -0
- package/bin/cli.cjs +2002 -0
- package/bin/cli.js +1960 -0
- package/package.json +89 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
ISC License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 ToneFlix Technologies Limited
|
|
4
|
+
|
|
5
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
|
6
|
+
purpose with or without fee is hereby granted, provided that the above
|
|
7
|
+
copyright notice and this permission notice appear in all copies.
|
|
8
|
+
|
|
9
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
10
|
+
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
11
|
+
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
12
|
+
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
13
|
+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
14
|
+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
15
|
+
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Grithub
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@toneflix/grithub)
|
|
4
|
+
[](https://github.com/toneflix/grithub/blob/main/LICENSE)
|
|
5
|
+
[](https://github.com/toneflix/grithub/actions/workflows/ci.yml)
|
|
6
|
+
[](https://github.com/toneflix/grithub/actions/workflows/deploy-docs.yml)
|
|
7
|
+
|
|
8
|
+
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.
|
|
9
|
+
|
|
10
|
+
## Install
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
pnpm add -g @toneflix/grithub
|
|
14
|
+
# or npm i -g @toneflix/grithub
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Quick start
|
|
18
|
+
|
|
19
|
+
- Login: `grithub login` (opens browser flow, stores token locally)
|
|
20
|
+
- Set default repo: `grithub set-repo owner/name`
|
|
21
|
+
- Inspect info: `grithub info`
|
|
22
|
+
- Work with issues (interactive): `grithub issues` to list, view, close/reopen, edit, or delete
|
|
23
|
+
- Seed/update/delete issues in bulk: `grithub issues:seed`, `grithub issues:update`, `grithub issues:delete`
|
|
24
|
+
|
|
25
|
+
## Generated API commands (dynamic)
|
|
26
|
+
|
|
27
|
+
The CLI can generate commands directly from the GitHub OpenAPI spec. This keeps available commands and params in sync with GitHub without hand-coding.
|
|
28
|
+
|
|
29
|
+
1. Generate commands (writes `.grithub/apis.generated.js`):
|
|
30
|
+
```bash
|
|
31
|
+
grithub generate:apis
|
|
32
|
+
```
|
|
33
|
+
2. Use generated commands (examples):
|
|
34
|
+
- Create issue: `grithub issues:create --title "Bug" --owner org --repo repo`
|
|
35
|
+
- List issues: `grithub issues:list-for-repo --owner org --repo repo`
|
|
36
|
+
- Get single issue: `grithub issues:get --owner org --repo repo --issue_number 123`
|
|
37
|
+
|
|
38
|
+
Notes
|
|
39
|
+
|
|
40
|
+
- The generator runs once and the CLI will auto-load `.grithub/apis.generated.js` on subsequent runs.
|
|
41
|
+
- Only the command usage matters; you do not need to edit the generated file by hand.
|
|
42
|
+
|
|
43
|
+
## Contributing
|
|
44
|
+
|
|
45
|
+
## Contributing
|
|
46
|
+
|
|
47
|
+
Contributions are welcome! Please follow these steps:
|
|
48
|
+
|
|
49
|
+
1. Fork the repository
|
|
50
|
+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
|
|
51
|
+
3. Commit your changes (`git commit -m 'Add amazing feature'`)
|
|
52
|
+
4. Push to the branch (`git push origin feature/amazing-feature`)
|
|
53
|
+
5. Open a Pull Request
|
|
54
|
+
|
|
55
|
+
### Development Guidelines
|
|
56
|
+
|
|
57
|
+
- Write TypeScript with proper type definitions
|
|
58
|
+
- Follow existing code style
|
|
59
|
+
- Add tests for new features
|
|
60
|
+
- Update documentation for API changes
|
|
61
|
+
- Ensure all tests pass before submitting PR
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
This project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.
|
|
66
|
+
|
|
67
|
+
## Support
|
|
68
|
+
|
|
69
|
+
- Email: support@toneflix.net
|
|
70
|
+
- Issues: [GitHub Issues](https://github.com/toneflix/grithub/issues)
|
|
71
|
+
- Docs: [Octokit Documentation](https://octokit.github.io/rest.js)
|
|
72
|
+
- Docs: [Github REST API Documentation](https://docs.github.com/en/rest)
|
|
73
|
+
|
|
74
|
+
## Acknowledgments
|
|
75
|
+
|
|
76
|
+
- Built with [H3ravel Musket](https://github.com/h3ravel/musket)
|
|
77
|
+
- Powered by [Github](https://github.com)
|
|
78
|
+
- Tunneling by [ngrok](https://ngrok.com) (coming soon)
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
**© Copyright 2026 - [ToneFlix Technologies Limited](https://toneflix.net)**
|