Skip to content

Commit 6532433

Browse files
cqb13cqb13
committed
imrpoved cli
1 parent 73fd494 commit 6532433

6 files changed

Lines changed: 722 additions & 495 deletions

File tree

‎Cargo.lock‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "github-stats"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
edition = "2021"
55
authors = ["cqb13 <cqb13.dev@gmail.com>"]
66
license = "MIT"

‎README.md‎

Lines changed: 46 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -45,48 +45,55 @@ After installing `gstats`, you can run `gstats help` to see all available comman
4545
## Usage
4646

4747
```bash
48+
4849
USAGE:
49-
github-stats [COMMAND] [OPTIONS]
50+
gstats [COMMAND] [OPTIONS]
5051

5152
COMMANDS:
52-
version -v
53-
Displays the current version of github-stats
54-
install -
55-
Installs the files and directories
56-
repo -
57-
Gives general information about a repository
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-
Helps you with the commands
53+
help - Prints help information
54+
command <COMMAND> (optional) The command you want help with
55+
56+
version - Prints version information
57+
58+
install - Installs the files and directories
59+
60+
repo - Displays general information about a repositoy
61+
user <USER> (required) The user who owns the repository
62+
repository <REPOSITORY> (required) The name of the repository
63+
-o --output <OUTPUT> File path to save the json
64+
-d --display Converts the json to an easier format (will remove some data)
65+
66+
repo - Displays general information about a repositoy
67+
user <USER> (required) The user who owns the repository
68+
repository <REPOSITORY> (required) The name of the repository
69+
-o --output <OUTPUT> File path to save the json
70+
-d --display Converts the json to an easier format (will remove some data)
71+
72+
releases - Displays informatiom about github releases
73+
user <USER> (required) The user who owns the repository
74+
repository <REPOSITORY> (required) The name of the repository
75+
-i --individual Displays downloads per release along with total downloads
76+
-l --link Displays download links for releases (if not individiual then for latest)
77+
-o --output <OUTPUT> File path to save the json
78+
-a --all Saves all the json from the request insteaad of a cleaned up version
79+
-d --display Converts the json to an easier format (will remove some data)
80+
81+
user - Displays information about a github user
82+
user <USER> (required) The user who owns the repository
83+
-o --output <OUTPUT> File path to save the json
84+
-d --display Converts the json to an easier format (will remove some data)
85+
86+
followers - Displays the followers of a github user
87+
user <USER> (required) The user who owns the repository
88+
-t --toal Displays the total follower count
89+
-o --output <OUTPUT> File path to save the json
90+
-d --display Converts the json to an easier format (will remove some data)
91+
92+
following - Displays the users a github user is following
93+
user <USER> (required) The user who owns the repository
94+
-t --toal Displays the total follower count
95+
-o --output <OUTPUT> File path to save the json
96+
-d --display Converts the json to an easier format (will remove some data)
9097
```
9198

9299
## Contributing

0 commit comments

Comments
 (0)