|
42 | 42 |
|
43 | 43 | After installing `gstats`, you can run `gstats help` to see all available commands and how to use them. Make sure that the installation path of `gstats` is added to your system's PATH, so it can be run from any terminal session. |
44 | 44 |
|
45 | | -## Features |
46 | | - |
47 | | -- **Version**: Display the current version of `gstats`. |
48 | | -- **Install**: Installs the necessary files and directories for the tool. |
49 | | -- **All Stats**: Fetches all available statistics for a specified repository in JSON format. |
50 | | -- **Releases**: Provides information about the releases of a specified repository. |
51 | | -- **User Info**: Retrieves detailed information about a GitHub user. |
52 | | - |
53 | 45 | ## Usage |
54 | 46 |
|
55 | | -Below are the commands available in `gstats`: |
56 | | - |
57 | | -### General |
58 | | - |
59 | | -- `gstats help`: Displays help information about the commands. |
60 | | - |
61 | | -### Version |
62 | | - |
63 | | -- `gstats version`: Shows the current version of `gstats`. |
64 | | - |
65 | | -### Repository Statistics |
66 | | - |
67 | | -- `gstats all -u <USER> -r <REPOSITORY> [-o <OUTPUT>] [-d]` |
68 | | - - `-u, --user USER`: The owner of the repository. |
69 | | - - `-r, --repository REPOSITORY`: The name of the repository. |
70 | | - - `-o, --output OUTPUT`: Optional. File path to save the JSON output. |
71 | | - - `-d, --display`: Optional. Converts JSON to a more readable format (some data may be omitted). |
72 | | - |
73 | | -### Release Information |
74 | | - |
75 | | -- `gstats releases -u <USER> -r <REPOSITORY> [-i] [-l] [-o <OUTPUT>] [-a] [-d]` |
76 | | - - `-u, --user USER`: The owner of the repository. |
77 | | - - `-r, --repository REPOSITORY`: The name of the repository. |
78 | | - - `-i, --individual`: Optional. Includes download counts per release. |
79 | | - - `-l, --link`: Optional. Provides download links for releases. |
80 | | - - `-o, --output OUTPUT`: Optional. File path to save the JSON output. |
81 | | - - `-a, --all`: Optional. Fetches all JSON data from the request. |
82 | | - - `-d, --display`: Optional. Converts JSON to a more readable format (some data may be omitted). |
83 | | - |
84 | | -### User Information |
85 | | - |
86 | | -- `gstats user -u <USER> [-o <OUTPUT>] [-d]` |
87 | | - - `-u, --user USER`: The GitHub username to retrieve information for. |
88 | | - - `-o, --output OUTPUT`: Optional. File path to save the JSON output. |
89 | | - - `-d, --display`: Optional. Converts JSON to a more readable format (some data may be omitted). |
| 47 | +```bash |
| 48 | +USAGE: |
| 49 | + github-stats [COMMAND] [OPTIONS] |
| 50 | + |
| 51 | +COMMANDS: |
| 52 | + version -v |
| 53 | + Displays the current version of github-stats |
| 54 | + install - |
| 55 | + Installs the files and directories |
| 56 | + all - |
| 57 | + Gives all stats found on a repository as json |
| 58 | + -u --user <USER> The user who owns the repository |
| 59 | + -r --repository <REPOSITORY> Name of the repository |
| 60 | + -o --output <OUTPUT> File path to save the json |
| 61 | + -d --display <> Converts the json to an easier format (will remove some data) |
| 62 | + releases - |
| 63 | + Gives information on github releases |
| 64 | + -u --user <USER> The user who owns the repository |
| 65 | + -r --repository <REPOSITORY> Name of the repository |
| 66 | + -i --individual <> Downloads per release |
| 67 | + -l --link <> Download links for releases (if not individual then for latest) |
| 68 | + -o --output <OUTPUT> File path to save the json |
| 69 | + -a --all <> All json from request |
| 70 | + -d --display <> Converts the json to an easier format (will remove some data) |
| 71 | + user - |
| 72 | + Gives information about a github user |
| 73 | + -u --user <USER> The user you want information on |
| 74 | + -o --output <OUTPUT> File path to save the json |
| 75 | + -d --display <> Converts the json to an easier format (will remove some data) |
| 76 | + followers - |
| 77 | + Lists the followers of a github user |
| 78 | + -u --user <USER> The user you want information on |
| 79 | + -t --total <TOTAL> Gives the follower count |
| 80 | + -o --output <OUTPUT> File path to save the json |
| 81 | + -d --display <> Converts the json to an easier format (will remove some data) |
| 82 | + following - |
| 83 | + Lists users the user is following |
| 84 | + -u --user <USER> The user you want information on |
| 85 | + -t --total <TOTAL> Gives the following count |
| 86 | + -o --output <OUTPUT> File path to save the json |
| 87 | + -d --display <> Converts the json to an easier format (will remove some data) |
| 88 | + help -h |
| 89 | +``` |
90 | 90 |
|
91 | 91 | ## Contributing |
92 | 92 |
|
|
0 commit comments