Schild CLI

Category: Other
Summary:
This article covers the Schild CLI-how to install it, and what it's for.

Overview

The Schild CLI is a tool for users completing cyber assignments. Using the CLI can be significantly faster than using a browser and includes everything available in a browser.

Setup

The first step is generating an API token. API tokens can be generated on the main site. To generate a token:

1. Navigate to Profile → Settings.
2. Find CLI API Tokens.
3. Fill out the fields.
4. Hit Create token.
5. Copy the raw token at the top, and save it in a temporary .txt file somewhere convenient.

It's impossible getting the raw token again after leaving the page. We recommend cycling the tokens every 60 days or less.

API tokens can be viewed and deleted in administration by navigating to a user's page:

1. Navigate to Organizations → Users.
2. Select a user.
3. Find API TOKENS.
4. To delete, check Delete, and hit a save option at the bottom.

Installation

The Schild CLI package is hosted at a private address. To install:

1. Open up your preferred CLI.
2. Install Python, version 3.10 or greater.
3. Run [$/%/>/...] pip install --index-url \ "https://__token__:<RAW_TOKEN>@<yoursubdomain>.schilds.tech/api/v1/private-pkgs/simple/" schild-cli. Substitute your raw token for <RAW_TOKEN> and substitute your organization's subdomain for <yoursubdomain>.
4. Follow the prompts. Hit "y" to save the token in the keyring to bypass manual authentication on subsequent attempts.

You're all set! Run [$/%/>/...] schild --help to view the commands available. Users can view their last used token times in Users → Settings.

You can logout anytime by running [$/%/>/...] schild logout.

Uninstallation

To uninstall, first remove the token from your keyring:

1. Open up your preferred CLI.
2. Run [$/%/>/...] python -m keyring delete schild-cli <subdomain>, where <subdomain> is your organization's schild subdomain.

Then uninstall:

1. Open up your preferred CLI.
2. Run [$/%/>/...] pip uninstall schild-cli.

You're all set.