https://github.com/isitreallyalive/snipe-yourself
🎯 Generate a report of your chokes to snipe them with ease!
https://github.com/isitreallyalive/snipe-yourself
cli game osu rhythm
Last synced: 3 months ago
JSON representation
🎯 Generate a report of your chokes to snipe them with ease!
- Host: GitHub
- URL: https://github.com/isitreallyalive/snipe-yourself
- Owner: isitreallyalive
- License: mit
- Created: 2021-12-21T21:23:51.000Z (over 4 years ago)
- Default Branch: old-js
- Last Pushed: 2024-09-01T20:02:47.000Z (almost 2 years ago)
- Last Synced: 2025-07-01T06:44:23.644Z (about 1 year ago)
- Topics: cli, game, osu, rhythm
- Language: TypeScript
- Homepage:
- Size: 1.29 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# snipe-yourself
Generate a report of your osu! chokes to snipe them with ease!
[](https://npmjs.org/package/snipe-yourself)
[](https://npmjs.org/package/snipe-yourself)
[](https://github.com/newtykins/snipe-yourself/blob/main/package.json)
* [snipe-yourself](#snipe-yourself)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g snipe-yourself
$ snipe COMMAND
running command...
$ snipe (--version)
snipe-yourself/1.0.0 linux-x64 node-v16.13.1
$ snipe --help [COMMAND]
USAGE
$ snipe COMMAND
...
```
# Commands
* [`snipe autocomplete [SHELL]`](#snipe-autocomplete-shell)
* [`snipe commands`](#snipe-commands)
* [`snipe config list`](#snipe-config-list)
* [`snipe config reset [SETTING]`](#snipe-config-reset-setting)
* [`snipe config set SETTING VALUE`](#snipe-config-set-setting-value)
* [`snipe help [COMMAND]`](#snipe-help-command)
* [`snipe profile [QUERY] [MODE]`](#snipe-profile-query-mode)
## `snipe autocomplete [SHELL]`
display autocomplete installation instructions
```
USAGE
$ snipe autocomplete [SHELL] [-r]
ARGUMENTS
SHELL shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
display autocomplete installation instructions
EXAMPLES
$ snipe autocomplete
$ snipe autocomplete bash
$ snipe autocomplete zsh
$ snipe autocomplete --refresh-cache
```
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v1.0.0/src/commands/autocomplete/index.ts)_
## `snipe commands`
list all the commands
```
USAGE
$ snipe commands [-h] [-j] [--hidden] [--columns | -x] [--sort ] [--filter ] [--output
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
FLAGS
-h, --help Show CLI help.
-j, --json display unfiltered api data in json format
-x, --extended show extra columns
--columns= only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter= filter property by partial string matching, ex: name=foo
--hidden show hidden commands
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output= output in a more machine friendly format
--sort= property to sort by (prepend '-' for descending)
DESCRIPTION
list all the commands
```
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v2.0.1/src/commands/commands.ts)_
## `snipe config list`
list all of the available settings!
```
USAGE
$ snipe config list
DESCRIPTION
list all of the available settings!
ALIASES
$ snipe config view
EXAMPLES
$ snipe config list
```
## `snipe config reset [SETTING]`
reset the config!
```
USAGE
$ snipe config reset [SETTING]
ARGUMENTS
SETTING the setting to clear
DESCRIPTION
reset the config!
ALIASES
$ snipe config clear
EXAMPLES
$ snipe config reset
```
## `snipe config set SETTING VALUE`
update a setting with a new value!
```
USAGE
$ snipe config set [SETTING] [VALUE]
ARGUMENTS
SETTING setting to update
VALUE value to update the setting to
DESCRIPTION
update a setting with a new value!
ALIASES
$ snipe config update
EXAMPLES
$ snipe config set client_id 11655
$ snipe config set secret your-epic-secret
$ snipe config set profile 16009610
```
## `snipe help [COMMAND]`
Display help for snipe.
```
USAGE
$ snipe help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for snipe.
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
## `snipe profile [QUERY] [MODE]`
rate a profile's chokes in terms of fixability
```
USAGE
$ snipe profile [QUERY] [MODE] [-c] [-j ] [-m osu|mania|taiko|fruits]
ARGUMENTS
QUERY the profile's ID or username
MODE the chosen osu! gamemode
FLAGS
-c, --console output the results to the console
-j, --json=path output the results as JSON
-m, --mode=mode the mode to calculate for
DESCRIPTION
rate a profile's chokes in terms of fixability
ALIASES
$ snipe calculate
EXAMPLES
$ snipe profile 16009610
$ snipe profile 16009610 -j
$ snipe profile 16009610 -c --json
$ snipe profile "Newt x3"
$ snipe profile
```
_See code: [dist/commands/profile/index.ts](https://github.com/newtykins/snipe-yourself/blob/v1.0.0/dist/commands/profile/index.ts)_