Skip to main content

Use Arena through command line interface

Project description

Arena-CLI

Official Command Line utility to use Arena in your terminal.

Arena-CLI is designed to extend the functionality of the Arena web application to command line to make the platform more accessible and terminal-friendly to its users.


Usage

Set token

arena set_token [TOKEN]

Push the docker image to arena backend

arena push -t track [IMAGE]:[TAG]

Source Installation

Arena-CLI and its required dependencies can be installed using pip:

pip install arena

Once Arena-CLI is installed, check out the usage documentation.

Development Setup

  1. Setup the development environment for Arena and make sure that it is running perfectly.

  2. Clone the arena-cli repository to your machine via git

    git clone https://github.com/guardstrikelab/arena-cli.git arena-cli
    
  3. Create a virtual environment

    cd arena-cli
    virtualenv -p python3 venv
    source venv/bin/activate
    
  4. Install the package locally

    pip install -e .
    
  5. Change the arena-cli host to make request to local Arena server running on http://localhost:8000 by running:

    arena host -sh http://localhost:8000
    
  6. Login to cli using the command arena login Two users will be created by default which are listed below -

    Host User - username: host, password: password
    Participant User - username: participant, password: password
    
  7. Push the docker image to arena backend

    arena push -t track [image]:[tag]
    

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arena-cli-1.7.tar.gz (12.2 kB view hashes)

Uploaded Source

Built Distribution

arena_cli-1.7-py3-none-any.whl (14.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page