https://github.com/davidthorn/githubuser
https://github.com/davidthorn/githubuser
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/davidthorn/githubuser
- Owner: davidthorn
- Created: 2018-01-14T15:07:03.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2018-01-28T14:37:53.000Z (over 8 years ago)
- Last Synced: 2025-01-31T14:47:49.532Z (over 1 year ago)
- Language: Swift
- Size: 28.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHubUser
## Documentation
[GitHub User Documentation](https://github.com/davidthorn/GitHubUser/tree/develop/Sources/GitHubUser)
## Installation
# GitHub User CLI
The GitHub User CLI provides the following commands
* id: displays the users id
```bash
# outputs the numberic id of the user
# github-user-cli USERNAME CMD
github-user-cli davidthorn id
User Id of: 16468826
```
* repos: Lists all repository names
```bash
# list all public repository names which are available to the user
# github-user-cli USERNAME CMD
github-user-cli davidthorn id
repo name: array
repo name: CalenderAPI
repo name: composer-test
repo name: DataRequest
```
* publicRepos: How many public repos that they have.
```bash
# list the number of public repository which the user has
# github-user-cli USERNAME CMD
github-user-cli davidthorn publicRepos
Public Repos Count: 15
```
* reposUrl: Outputs the repos urls for the user
```bash
# output the public repos url for the user
# github-user-cli USERNAME CMD
github-user-cli davidthorn publicRepos
Repos Url: https://api.github.com/users/davidthorn/repos
```
* And more to come..
## Installation
Using the cli requires firstly that the project has been built.
In order to build the project the swiftc compile is required to be installed.
Checkout the following link to install swift and swiftc:
[https://swift.org/getting-started/#installing-swift](https://swift.org/getting-started/#installing-swift)