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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file arena-cli-1.7.tar.gz.

File metadata

  • Download URL: arena-cli-1.7.tar.gz
  • Upload date:
  • Size: 12.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for arena-cli-1.7.tar.gz
Algorithm Hash digest
SHA256 06ffd90e13bff32f4b19edfe0d29de069449f7c719e08badd7e14d9903f8c117
MD5 8989abaf96269328c994a8dc316b19f9
BLAKE2b-256 cf5a46b039a1a13246e3f4a6a50a60d081f7d91bb5a4b1c993cae71712c615fd

See more details on using hashes here.

File details

Details for the file arena_cli-1.7-py3-none-any.whl.

File metadata

  • Download URL: arena_cli-1.7-py3-none-any.whl
  • Upload date:
  • Size: 14.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.16

File hashes

Hashes for arena_cli-1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 34543f15e688eaa0312e0a06caf06f06a7238aa6b420984574f9b61032b931c1
MD5 177460180316f83645f7bdf51918bfcd
BLAKE2b-256 6c1de5775e3c09a9574d1347f11f14aab889339f5e619e59b754d1dfdd6fad68

See more details on using hashes here.

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