0.0.5 • Published 1 year ago

octoshell v0.0.5

Weekly downloads
-
License
CC-BY-4.0
Repository
github
Last release
1 year ago

OctoShell

A command line interface to interact with GitHub using Node.js.

Installation

To install OctoShell, use npm:

npm i octoshell -g

Usage

To use OctoShell, run the command octo or octoshell followed by a command:

octo [command]

Available commands are:

  • auth: Authenticate with GitHub and get your personal access token.
  • explore: Explore GitHub repositories.
  • star: Star a GitHub repository.
  • publish: Publish a GitHub repository.
  • gist: Create a GitHub gist.

auth

To authenticate with GitHub, run:

octo auth

explore

To explore random GitHub repositories, run:

octo explore

star

To star a GitHub repository, run:

octo star [repo_full_name]

Replace the [repo_full_name] with the repo full name. e.g: octo star abdlmutii/cli, you can also type octo star random to star random repo! Note: Before using this command, you need to authenticate with GitHub and set your personal access token. You can authenticate with GitHub by running octo auth

publish

To publish a GitHub repository, run:

octo publish [reponame]

Note: Before using this command, you need to authenticate with GitHub and set your personal access token. You can authenticate with GitHub by running octo auth

gist

To create a GitHub gist, run:

octo gist [filename] [optinal:description]

Note: Before using this command, you need to authenticate with GitHub and set your personal access token. You can authenticate with GitHub by running octo auth.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

License

This project is licensed under the CC-BY-4.0 License - see the LICENSE.md file for details.

Credits

Credits goes to abdlmutii, if you like this npm package please remember to check other work i've done on github and octo star abdlmutii/octoshell 😉. Email: abdlmutii@outlook.com Business Email: abdlmutii.buz@outlook.com