<!-- Source: https://docs.squirro.com/en/latest/technical/api/toolbox/index.html -->
# Squirro Toolbox

The Squirro Toolbox is a set of command line interface (CLI) utilities that you install on your own machine to work with a Squirro instance. Use it to load data into a project, export project content, and manage custom assets such as pipelets and custom widgets. The Toolbox also bundles the [SquirroClient (Python SDK)](../squirro_client/index.md#squirro-client) Python SDK, so installing the Toolbox makes `squirro_client` available in the same environment, without a separate installation.

> **Note**
>
> The Toolbox handles individual data and asset tasks. To manage the whole configuration of an instance as version-controlled files, and promote it from one environment to the next, use Squirro CLI instead. For more information, see the [Squirro CLI](../../cli/index.md#squirro-cli) page.

## Downloading and Installing the Toolbox

Squirro distributes the Toolbox as a Python wheel file through the [Downloads](https://go.squirro.com/downloads) wiki page, which requires dedicated access. That page lists the latest stable release and the latest long-term support (LTS) release, and links to an archive of earlier releases.

If you cannot open the Downloads page, request access as follows:

1. Visit the [Squirro Support website](https://go.squirro.com/support) and submit a technical support request for access to the Downloads page, listing the email address of every person who needs it.
2. Accept the invitation sent to each of those email addresses.
3. Open the [Downloads](https://go.squirro.com/downloads) wiki page and download the wheel file listed for the Squirro Toolbox.

The Toolbox runs on Windows, macOS, and Linux, and requires Python. For installation instructions, see the [Install In a Python Environment](install-python.md#toolbox-install-python) page. For the differences between operating systems, see the [Toolbox Differences Between macOS / Linux / Windows](differences.md#toolbox-differences) page.

## Included Tools

- `squirro_data_load`

  Loads data from multiple sources into a Squirro project. For more information, see the [Data Loader CLI Tool](../../data-loading/data-loader.md#data-loading-loader) page.
- `squirro_bulk_export`

  Extracts the content of a Squirro project and exports it to a CSV file. For more information, see the [Bulk Exporter](bulk-exporter.md#toolbox-exporter) page.
- `squirro_asset`

  Manages all Squirro code artifacts called custom assets, such as pipelets, custom widgets, and custom dashboard loaders. For more information, see the [squirro_asset CLI Reference](asset-cli.md#toolbox-asset-cli) page.
- `squirro_widget`

  Uploads and lists custom widgets. The `squirro_asset` tool performs the same operations, using the same options as for the other asset types.
- `pipelet`

  Validates, tests, uploads, and lists pipelets, and re-runs one on items already indexed on the server. For more information, see the [Pipelets](../../pipelets/index.md#pipelets) page.
- `squirro_kee`

  Sets up and deploys [Known Entity Extraction](../../kee/index.md#kee) to a Squirro project. For more information, see the [KEE CLI Tool](../../kee/cli.md#kee-cli) page.
- `squirro_project_template`

  Turns an exported `sqproj` file into a project template that users can select in the Create Project dialog. For more information, see the [Project Templates Overview](../../templates/project-templates.md#project-templates-pt) page.
