Skip to content

haithamaouati/Copilot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Copilot

A Bash tool to fetch and display GitHub user information in JSON format using the GitHub API.

Screenshot

screenshot

Usage

To use the Copilot script, follow these steps:

  1. Clone the repository:

    git clone https://github.com/haithamaouati/Copilot.git
  2. Change to the Copilot directory:

    cd Copilot
  3. Change the file modes

    chmod +x copilot.sh
  4. Run the script:

    ./copilot.sh
Syntax:
./copilot.sh [options]
Options:

Examples:

  1. Fetch user information without authentication:
./copilot.sh -u octocat
  1. Fetch user information with a personal access token:
./copilot.sh -u octocat -t ghp_12345abcdef
  1. Save the response to a file:
./copilot.sh -u octocat -f user_data.json

Configuration

If you frequently use a personal access token, you can preload it by creating a token file in the script's directory. The script will automatically detect and use it:

echo "ghp_12345abcdef" > token

Dependencies

The script requires the following dependencies:

  • figlet: Program for making large letters out of ordinary text
  • curl: Command line tool for transferring data with URL syntax
  • jq: Command-line JSON processor

Make sure to install these dependencies before running the script.

Author

Made with ☕ by Haitham Aouati

License

Copilot is licensed under Unlicense license.

About

Copilot: GitHub User Info Fetcher

Resources

Stars

Watchers

Forks

Languages