Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/claytonpassmore/app-manager

Small Python package for running apps with tmux or screen
https://github.com/claytonpassmore/app-manager

Last synced: about 1 month ago
JSON representation

Small Python package for running apps with tmux or screen

Awesome Lists containing this project

README

        

# App Manager
Manage your apps with the help of tmux (or screen)!

## Install
Run the following:
```bash
# Install pre-reqs (note that you can use screen instead of tmux)
brew install python && brew install tmux

# Clone the repo
git clone [email protected]:ClaytonPassmore/app-manager.git

# Install the package
pip install -e ./app-manager
```

## Configure
Create the following file: `~/.app_manager.yml`.

Fill it with the apps you want to run in the following format:
```yml
:
root:
start:
setup:
-
-
-
:
...
```

You can also specify the window manager you would like to use with the `manager` key.
Tmux is used by default, but screen is also available.
```yml
manager: screen
...
```

## Commands
Installing this package gives you the following commands:

### `start`
```
usage: start [-h] [-v] [-s] [-a] app

Start an app

positional arguments:
app The app to start

optional arguments:
-h, --help show this help message and exit
-v, --verbose Show error stack traces
-s, --setup Run setup commands before starting
-a, --attach Start the app in attached mode
```

### `attach`
```
usage: attach [-h] [-v] app

Attach a running app

positional arguments:
app The app to attach

optional arguments:
-h, --help show this help message and exit
-v, --verbose Show error stack traces
```

### `restart`
```
usage: restart [-h] [-v] [-s] [-a] app

Restart a running app

positional arguments:
app The app to restart

optional arguments:
-h, --help show this help message and exit
-v, --verbose Show error stack traces
-s, --setup Run setup commands before starting
-a, --attach Start the app in attached mode
```

### `show`
```
usage: show [-h] [-v] [-a]

List configured apps

optional arguments:
-h, --help show this help message and exit
-v, --verbose Show error stack traces
-a, --all Show all apps
```

### `stop`
```
usage: stop [-h] [-v] [app [app ...]]

Stop running apps

positional arguments:
app The app(s) to stop

optional arguments:
-h, --help show this help message and exit
-v, --verbose Show error stack traces
```