Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/github/gh-classroom
GitHub Classroom CLI Extension is a powerful and easy-to-use command line tool that enhances the functionality of the GitHub CLI, specifically tailored for educators using GitHub Classroom.
https://github.com/github/gh-classroom
gh-extension
Last synced: about 1 month ago
JSON representation
GitHub Classroom CLI Extension is a powerful and easy-to-use command line tool that enhances the functionality of the GitHub CLI, specifically tailored for educators using GitHub Classroom.
- Host: GitHub
- URL: https://github.com/github/gh-classroom
- Owner: github
- License: mit
- Created: 2023-03-15T18:59:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-14T19:24:56.000Z (3 months ago)
- Last Synced: 2024-09-30T00:06:05.887Z (about 1 month ago)
- Topics: gh-extension
- Language: Go
- Homepage:
- Size: 4.32 MB
- Stars: 82
- Watchers: 5
- Forks: 14
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
- awesome-gh-cli-extensions - **classroom** - Official extension for GitHub Classroom. (GitHub Education)
README
## GitHub Classroom CLI
GitHub Classroom CLI Extension is a powerful and easy-to-use command line tool that enhances the functionality of the GitHub CLI, specifically tailored for educators using GitHub Classroom.
[Learn more about how to use this extension on docs.github.com](https://docs.github.com/en/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)
## Background
- **This project does not currently have a roadmap**
- If you would like to add additional features, please read our [contribution guidelines](./CONTRIBUTING.md)
- To report a security vulnerability, please read our [security guidelines](./SECURITY.md)
## Requirements
### Installation
- Install [Homebrew](https://brew.sh/)
- Install the gh cli
```bash
brew install gh
```
- Install this extension
```bash
gh extension install github/gh-classroom
```
- To update this extension
```bash
gh extension upgrade classroom
```
### Commands
For more information and a list of available commands
```bash
gh classroom -h
```
## License
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
## Maintainers
See [CODEOWNERS](./CODEOWNERS)
## Support
See [SUPPORT](./SUPPORT.md)
## Additional Resources
- [REST API Documentation](https://docs.github.com/en/rest/classroom/classroom?apiVersion=2022-11-28)
- [Adding new commands](https://github.blog/2023-09-25-calling-all-teachers-learn-how-to-build-new-commands-on-the-github-classroom-cli/)
- [Documentation for this extension on docs.github.com](https://docs.github.com/en/education/manage-coursework-with-github-classroom/teach-with-github-classroom/using-github-classroom-with-github-cli)
- [Classroom](https://classroom.github.com)
- [About Extensions](https://docs.github.com/en/github-cli/github-cli/creating-github-cli-extensions)
- [Extensions Deep Dive](https://github.blog/2023-01-13-new-github-cli-extension-tools/)