The BugSwarm Client

The official command line client for the BugSwarm artifact dataset

This repository is deprecated. Please click here for the latest client library.

Installation

Requires Python 3.

$ pip3 install bugswarm-client

Usage

Download a Docker image and enter the Docker container associated with an artifact.

$ bugswarm run --image-tag <image_tag>

Depending on how Docker is configured on your machine, you may need to enter an administrator password.

Download a Docker image and enter the Docker container with a shared folder between the container and the host machine.

$ bugswarm run --image-tag <image_tag> --use-sandbox

Show metadata for an artifact.

$ bugswarm show --image-tag <image_tag> --token <token>

Show usage text for the entire tool or for a specific sub-command.

$ bugswarm --help
$ bugswarm <sub-command> --help

Show the version.

$ bugswarm --version

Please note that artifacts are first attempted to be pulled from bugswarm/cached-images, and if not found then they are attempted to be pulled from bugswarm/images.

Example

$ bugswarm run --image-tag nutzam-nutz-140438299
$ bugswarm show --image-tag nutzam-nutz-140438299 --token <token>

Requires a token

Development

Execute the following commands to install the tool in "editable" mode.

1. Clone this repository.

   $ git clone https://github.com/BugSwarm/client.git
   

2. cd into the root directory of this repository.

   $ cd client
   

3. Install the tool.

   $ pip3 install --upgrade --force-reinstall -e .