AlexanderBrevig/marauder

I solemnly swear I am up to no good

Marauder

A tool for documenting CLI operations.
I solemnly swear I am up to no good.
Explore the docs »

· Report Features & Bug

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

First run the project. I may suggest aliasing it to log proof oscplog whatever fits your needs.

marauder ls -la

Running this command will create one a text file for future reference.

alexander@devbox:/home/alexander/github.com/marauder$ ls -la
totalt 72
drwxr-xr-x 8 alexander alexander 4096 feb.   8 00:37 .
drwxr-xr-x 9 alexander alexander 4096 feb.   5 23:00 ..
drwxr-xr-x 2 alexander alexander 4096 feb.   8 00:38 assets
drwxr-xr-x 3 alexander alexander 4096 feb.   5 23:03 cmd
drwxr-xr-x 8 alexander alexander 4096 feb.   7 23:06 .git
drwxr-xr-x 3 alexander alexander 4096 feb.   6 01:12 .github
-rw-r--r-- 1 alexander alexander  289 feb.   6 01:29 .gitignore
-rw-r--r-- 1 alexander alexander  250 feb.   7 23:06 go.mod
-rw-r--r-- 1 alexander alexander  681 feb.   7 23:06 go.sum
-rw-r--r-- 1 alexander alexander 6377 feb.   8 00:37 index.html
-rw-r--r-- 1 alexander alexander 1073 feb.   7 23:06 LICENSE
drwxr-xr-x 2 alexander alexander 4096 feb.   8 00:12 logo
drwxr-xr-x 3 alexander alexander 4096 feb.   7 23:06 pkg
-rw-r--r-- 1 alexander alexander  981 feb.   6 02:03 PKGBUILD
-rw-r--r-- 1 alexander alexander 5407 feb.   8 00:37 README.md
-rw-r--r-- 1 alexander alexander  358 feb.   6 02:07 .SCRINFO

You will also get a fake screenshot of a terminal, handy for writing reports.

Built With

• Go

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• golang

Installation

1. Clone the repo

   git clone https://github.com/alexanderbrevig/marauder.git

2. Run the program

   go run ./cmd/marauder ls -la

3. Install if you want

   GOBIN=/usr/local/bin/ go install ./cmd/marauder

Usage

marauder ls -la

You will now have a file called $DATE ls -la.txt with the output of ls, and a $DATE ls -la.png with a simulated screenshot of the terminal.

Configuration

Place a .marauder.yml in your home directory. Optionally choose any location and set MARAUDER_CONFIG to point to that directory.

# /home/alexander/.marauder.yml
#userName: alexander
#hostName: devbox
outDir: /home/alexander/github.com/marauder/test
datePrefix: false
lineLimit: 100
fontSIze: 16
terminalMargin: 10
textMargin: 10
colors:
    button1: "ff0000"
    button2: "ffff00"
    button3: "00ff00"
    background: "060606"
    title: "666666"
    userName: "89b482"
    at: "ffffff"
    hostName: "ea6962"
    dollar: "ffffff"
    command: "ff0000"
    terminal: "ffffff"

It is also worth knowing that every config has a corresponding environment variable.

They map such that the userName stanza becomes MARAUDER_USER_NAME. You can also override colors with MARAUDER_COLOR_*.

If you want to signal something as green, do

MARAUDER_COLOR_COMMAND="00ff00" marauder ls -la

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contribuions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Alexander Brevig - @alexanderbrevig - alexanderbrevig@gmail.com

Project Link: https://github.com/alexanderbrevig/marauder

Acknowledgements

• Amazing Go Graphics Library