Skip to content
This repository has been archived by the owner on Nov 14, 2022. It is now read-only.

monuelo/cast-sh

dev
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
art
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

cast-sh

Build Status Coverage Status Python 3.5-3.7 Code style: black Total alerts Language grade: Python Language grade: JavaScript

Installation & Prerequisites

Use the package manager pip to install the dependencies before run the application

pip3 install -r requirements.txt

Usage

To start the terminal cast application, run:

python3 -m cast

Or if you install the application via pip:

pip install .

# command available once pkg has been installed
cast-sh

Arguments

optional arguments:

  -h, --help                show this help message and exit
  -p [PORT], --port [PORT]  port to run server on (default: 5000)
  --debug                   debug the server (default: False)
  --version                 print version and exit (default: False)
  --command COMMAND         Command to run in the terminal (default: bash)
  --cmd-args CMD_ARGS       arguments to pass to command (i.e. --cmd-args='arg1
                            arg2 --flag') (default: )
  --password PASSWORD       set a password for accessing cast-sh
                            sessions (default: admin)

A password can be set using an environment variable as well.

Unix

export PASSWORD="weakpassword"

Windows

set PASSWORD="weakpassword"

Docker

Build image

docker build -t cast .

Run built image

docker run --name cast.sh-container -p 5000:5000/tcp -i -t cast

Screenshots

screenshots

Contributing

Contribute

License

Code of Conduct

Everyone interacting with the cast-sh codebase and issue tracker is expected to follow our Code of Conduct.