https://github.com/dainfloop/sprig-cli

Manage your Sprig from the CLI!
https://github.com/dainfloop/sprig-cli

Last synced: about 18 hours ago
JSON representation

Manage your Sprig from the CLI!

• Host: GitHub
• URL: https://github.com/dainfloop/sprig-cli
• Owner: DaInfLoop
• License: mit
• Created: 2024-10-30T22:00:49.000Z (8 days ago)
• Default Branch: main
• Last Pushed: 2024-10-31T14:01:58.000Z (7 days ago)
• Last Synced: 2024-10-31T14:33:16.566Z (7 days ago)
• Language: Python
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sprig CLI

An unofficial tool to help you manage your [Sprig](https://sprig.hackclub.com)!

> [!WARNING]  

> This is an unofficial tool and barely tested. I do not assume any responsibility for any damages caused to your Sprig while using this tool.

>

> That being said, if any bugs do arise, please contact me in [my channel on the Hack Club Slack](https://hackclub.slack.com/archives/C06SY7X0ESK)!

## Installation

Head over to [nightly.link](https://nightly.link/DaInfLoop/sprig-cli/workflows/build/main) and grab the binary for your OS.

## Usage

Once installed, run `./sprig  [options]` or `./sprig.exe  [options]`.

```

Usage: sprig  [options]

  sprig CLI - a tool to help you interact with your Sprig

Options:

  --help  Show this message and exit.

Commands:

  flash    Flash your Sprig with the latest firmware

  upload   Upload a game to your Sprig

  version  Get the version of your Sprig connected to this device

```

### sprig flash

Flashes the latest SPADE software on to your Sprig. Requires your Sprig to be in [BOOTSEL mode](https://github.com/hackclub/sprig/blob/main/docs/UPLOAD.md#bootsel).

```

$ sprig flash

Flashing firmware to your Sprig (/media/haroon/RPI-RP2)...

Firmware flashed successfully!

```

### sprig upload \ [--name "..."]

Upload a game to your Sprig, and optionally give it a name to be displayed.

```

$ sprig upload game.js --name "My Game"

Uploading game.js to your Sprig...

Upload completed successfully!

```

### sprig version

View what version of SPADE is on your Sprig

```

$ sprig version

Your Sprig is on SPADE version: 2.0.1

```

## License

This software is licensed under the MIT License. A version of this is avaliable for reading at [LICENSE](/LICENSE).