Skip to content

Commit

Permalink
Adding screenshots and adjusting readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BitlyTwiser committed Sep 15, 2024
1 parent 08c1e8a commit 68be001
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,31 @@
<div align="center">

# Apprunner
- The premise is simple, add stuff to the yml file. This *stuff* is commands, the location to run the command from (if not standalone) and the name.
- Run the code, and you will get N number of Tmux windows, with the name field from the yaml alloted to it, running the command you passed in.
<img src="/assets/apprunner.jpg" width="450" height="500">
</div>

The premise is simple, add stuff to the yml file. This *stuff* is commands, the location to run the command from (if not standalone) and the name.
Run the code, and you will get N number of Tmux windows, with the name field from the yaml alloted to it, running the command you passed in.

# Prerequisites:
- You DO need Tmux for this: https://github.com/tmux/tmux/wiki
- Fill out the yaml
- $$$ run stuff
1. You DO need Tmux for this: https://github.com/tmux/tmux/wiki
2. Fill out the yaml
example:
```
apps:
- name: test1
command: ping google.com
stand: true
location: ./var/thing
- name: test2
command: ls -la
stand: false
location: /var/log
```
3. $$$ run stuff
4. Terminal with commands will appear:
![Screenshot](/assets/screenshot1.png)
![Screenshot](/assets/screenshot2.png)
# How it works:
- This program executes tmux hooks to spawn a session, then add N number of windows to the session passing the keys to the given window. I.e. command -> window -> execute.
Expand All @@ -14,4 +34,3 @@ Example from the CLI:
tmux new-session -s test_sesh \; rename-window -t test_sesh:0 inner_window \; send-keys -t test_sesh:inner_window 'echo "hi" |base64' enter
```
This will spawn a new tmux session, create & rename the window, and run the command echoing hi to base64 encode.
Binary file added assets/apprunner.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/screenshot2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 68be001

Please sign in to comment.