kicker

CLI tool designed to simplify the process of obtaining Kick API Access Tokens and Refresh Tokens.

• Handles the PKCE challenge generation
• Spins up a temporary local server to capture the callback code from the browser
• Exchanges callback code to return access and refresh tokens directly in the terminal

Installation

Make sure you have Crystal installed on your machine.

# 1. Clone the repository
git clone https://github.com/zerohxyz/kicker.git

# 2. Navigate into the project directory
cd kicker

# 3. Build
shards build --release

Usage

To use this tool, you must first create an application in the Kick Developer Portal to get your credentials.

Once you have them, run the compiled program by passing your keys and a custom PKCE verifier string using the flags below:

./kicker --client-id="YOUR_KICK_ID" --client-secret="YOUR_KICK_SECRET" --verifier="VERIFIER_STRING"
# or
./kicker -i "YOUR_KICK_ID" -s "YOUR_KICK_SECRET" -v "VERIFIER_STRING"

Development

To run the application locally in development mode without compiling a release binary, use shards run.

Pass your CLI flags after a double dash (--):

shards run -- -i TEST_ID -s TEST_SECRET -v TEST_VERIFIER

Contributing

1. Fork it (https://github.com/zerohxyz/kicker/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• zeroh - creator and maintainer