Merge pull request #1 from ResistanceIsUseless/ResistanceIsUseless-Axiom-Commands-Cheatsheet

axiom commands cheatsheet

Author: 0xtavian

Diff for: Cheatsheet.md

@@ -2,29 +2,41 @@
 
 I've put together a little cheatsheet to help you on your way!
 
----
 
-## Pick a Packer provisioner
-We currently offer [three](https://github.com/pry0cc/axiom/tree/master/images/provisioners) different base images you can provision. Our [Default](https://github.com/pry0cc/axiom/blob/master/images/provisioners/full.json) provisioner comes with tools to run most [modules](https://github.com/pry0cc/axiom/tree/master/modules). The [ReconFTW](https://github.com/pry0cc/axiom/blob/master/images/provisioners/reconftw.json) provisioner comes with all tools installed and the [Barebones](https://github.com/pry0cc/axiom/blob/master/images/provisioners/barebones.json) provisioner comes with no tools installed. If you want to bring-you-own Packer JSON provisioner, select custom.
+---
+# axiom-build 
+**Pick a Packer provisioner** :hatching_chick:
+> You must run axiom-configure before anything else. THis creates your axiom.json file which is required by other commands.
 ```
 axiom-build
 ```
-## Initialize a single instance
+> We currently offer [three](https://github.com/pry0cc/axiom/tree/master/images/provisioners) different base images you can provision, and 2 custom images. 
+> - [Default](https://github.com/pry0cc/axiom/blob/master/images/provisioners/default.json) provisioner comes with all tools installed.
+> - [ReconFTW](https://github.com/pry0cc/axiom/blob/master/images/provisioners/reconftw.json) provisioner comes with all tools installed. 
+> - [Barebones](https://github.com/pry0cc/axiom/blob/master/images/provisioners/barebones.json) provisioner comes with no tools installed and is just the base ubuntu image.
 
+> Custom Images:
+> - [Full](https://github.com/pry0cc/axiom/blob/master/images/provisioners/full.json) provisioner comes with only tools with [modules](https://github.com/pry0cc/axiom/tree/master/modules) availabled. Reccomended for axiom-feet.
+> - [Light](https://github.com/pry0cc/axiom/blob/master/images/provisioners/light.json) provsioner comes with zsh and a few other minor adjustments over the barebones provsioner. 
+> If you want to bring-your-own Packer JSON provisioner, select custom. *Make sure your packer json is placed in ~/.axiom/images/provsioners*
 ---
+# axiom-init
+**Initialize a single instance** :seedling:
 
 ```bash
 axiom-init <name> # Init
-axiom-init <name> --deploy=<profile> --restore=<box> # Init & deploy & restore
+axiom-init <name> --deploy=<profile> --restore=<box> # Init & deploy & restore 
+#Note: profile argument is file name is without .json
 ```
-
-the `--deploy` option allows you to deploy a profile (stored in `~/.axiom/profiles/`). `--restore` will restore a profile. These options can be used together.
+> the `--deploy` option allows you to deploy a profile (stored in `~/.axiom/profiles/`). `--restore` will restore a profile. These options can be used together.
 
 ---
-
-## Connect to an instance
+# axiom-ssh
+**Connect to an instance** - axiom-connect**
 
 ```bash
+axiom-connect #automatically connects to list intialized instance
+axiom-connect <name>
 axiom-ssh <name> <ssh args>
 axiom-ssh <name> --tmux
 axiom-ssh <name> -m -t=<tmux session> # Connect with mosh and attach to tmux session
@@ -33,28 +45,30 @@ axiom-ssh <name> -L 8080:127.0.0.1:8080 -D 4040 # All additional SSH args are p
 axiom-ssh <name> --cache # Don't generate ssh config, just connect with cache
 axiom-ssh --just-generate # Generate an SSH config at ~/.axiom/.sshconfig
 ```
-
-## Backup an initialized instance to the cloud
+---
+# axiom-backup
+**Backup an initialized instance to the cloud** :luggage:
 
 ```bash
 axiom-backup 
 ```
 
-After running axiom-init you can set up config files, unique wordlists, private tools etc, take a snapshot of that image and use it to deploy future axiom instances/fleets. 
+> After running axiom-init you can set up config files, unique wordlists, private tools etc, take a snapshot of that image and use it to deploy future axiom instances/fleets. 
 
 ---
-
-## Backup the home directory of an initialized instance to the local filesystem
+# axiom-sync
+**Backup the home directory of an initialized instance to the local filesystem**
 
 ```bash
 axiom-sync instance01
 ```
 
-This allows you to download a copy of everything in an axiom instance to you local filesystem
+> This allows you to download a copy of everything in an axiom instance to you local filesystem
 
 ---
 
-## List all box backups
+# axiom-boxes
+**List all box backups** :brain:
 
 ```bash
 axiom-boxes ls # List boxes
@@ -65,59 +79,61 @@ axiom-boxes archive <box>  # Archive a box (tarball & gpg -e)
 axiom-boxes unarchive <box> # Unarchive (from ~/.axiom/archives/), gpg decrypts
 axiom-boxes get pry0cc/lazy # Get a box from  github, username/repo
 ```
-
-Using the archive option will convert the box to a tarball and encrypt using the email specified in your account `~/.axiom/accounts/*.json`
+> Using the archive option will convert the box to a tarball and encrypt using the email specified in your account `~/.axiom/accounts/*.json`
 
 ---
 
-## Manage user accounts
+# axiom-region
+**Switch to a new region** :compass:
 
 ```bash
-axiom-account-setup # Setup a new account
-axiom-account # No args, list available accounts
-axiom-account <account> # Select/Switch to the specifed account
+axiom-region ls # lists regions
+axiom-region select <region> # select region
+
+axiom-region select ams2
 ```
 
 ---
 
-## Initialize a fleet
+# axiom-account
+**Manage user accounts** 
 
 ```bash
-axiom-fleet -i=13 # Initialize a fleet, name it randomly
-axiom-fleet testy -i=8 # Initialize a fleet named 'testy', instances will be named, testy01, test02 etc
-axiom-fleet testy -i=10 --regions=NYC1,LON1,TOR1 # Initialize a fleet using round-robin region distribution  
+axiom-account-setup # Setup a new account
+axiom-account # No args, list available accounts
+axiom-account <account> # Select/Switch to the specifed account
 ```
-
 ---
 
-## Copy files to and from hosts
-
-Copy a remote file from all instances in myfleet to local folder. `'$name'` must be wrapped single quotes. `'$name'` is a required literal string and gets interpolated from the instance name. <br>
+# axiom-scp
+**Copy files to and from hosts** 
+> Copy a remote file from all instances in myfleet to local folder. `'$name'` must be wrapped single quotes. `'$name'` is a required literal string and gets interpolated from the instance name. <br>
 
 ```
 axiom-scp 'myfleet*':/home/op/myfile.txt '~/local/folder/$name.txt'
 ```
 
-Copy a remote file from one instance 'myfleet05' to a local file <br>
+> Copy a remote file from one instance 'myfleet05' to a local file <br>
 
 ```
 axiom-scp myfleet05:/home/op/myfile-from-myfleet05.txt '~/local/folder/myfile-from-myfleet05.txt'
 ```
 
-Copy a local file to all instances in myfleet, for example uploading a custom wordlist  <br> 
+> Copy a local file to all instances in myfleet, for example uploading a custom wordlist  <br> 
 
 ```
 axiom-scp myfile.txt 'myfleet*':/home/op/myfile.txt
 ```
 
-Copy a local folder to all instances in myfleet, for example uploading a folder of custom nuclei templates <br>
+> Copy a local folder to all instances in myfleet, for example uploading a folder of custom nuclei templates <br>
 
 ```
 axiom-scp mytemplates/ 'myfleet*':/home/op/custom-templates 
 ``` 
 ---
 
-## Deploy a profile
+# axiom-select
+**Deploy a profile** :mechanical_arm:
 
 ```bash
 axiom-select '<instance>'
@@ -126,57 +142,65 @@ axiom-deploy openvpn # Install openvpn against host or fleet
 axiom-deploy covenant # Install covenent
 ```
 
-All profiles can be found in `~/.axiom/profiles`
-
----
+> All profiles can be found in `~/.axiom/profiles`
 
-## Connect to an OpenVPN Server Deployed by Axiom
+**Connect to a remote axiom instance Docker (over ssh)**
 
 ```bash
-axiom-vpn <instance>
+axiom-select <instance>
+. axiom-docker # Not a typo, the . means source
+docker ps
 ```
-
 ---
-
-## Connect to a remote axiom instance Docker (over ssh)
+# axiom-vpn
+**Connect to an OpenVPN Server Deployed by Axiom** 
 
 ```bash
-axiom-select <instance>
-. axiom-docker # Not a typo, the . means source
-docker ps
+axiom-vpn <instance>
 ```
 
 ---
 
-## Proxy through a set of hosts (or one)
 
+# axiom-proxy
+**Proxy through a set of hosts (or one)**
 ```bash
 axiom-proxy '<fleet>*'
 axiom-proxy '<instance>'
 axiom-proxy 'testy*'
 proxychains4 curl -s ipinfo.io
 ```
-
-This will SSH tunnel all hosts to a range of  local ports, 127.0.0.1:5000-50100, then generate a proxychains configuration file to `./proxychains.conf`
+> This will SSH tunnel all hosts to a range of  local ports, 127.0.0.1:5000-50100, then generate a proxychains configuration file to `./proxychains.conf`
 
 ---
 
-## Create a DNS A record
-
+# axiom-dns
+**Create a DNS A record**
+*Currently only supported by Digital Ocean*
 ```bash
 axiom-dns ls # List domains
 axiom-dns ls <domain> # List records for domain
 axiom-dns add <subdomain> <domain> <ip address>
 axiom-dns add cisco navisec.xyz 167.71.89.136 # Example, this will create a record cisco.navisec.xyz pointing to 167.71.89.136 
 ```
-
-Domain names can be hosted in DigitalOcean ([https://cloud.digitalocean.com/networking/domains?](https://cloud.digitalocean.com/networking/domains?i=87a4bd))
+> Domain names can be hosted in DigitalOcean ([https://cloud.digitalocean.com/networking/domains?](https://cloud.digitalocean.com/networking/domains?i=87a4bd))
 
 ---
 
-## Scanning using a fleet
+# axiom-fleet
+**Initialize a fleet** :rocket:  
+
+```bash
+axiom-fleet -i=13 # Initialize a fleet, name it randomly
+axiom-fleet testy -i=8 # Initialize a fleet named 'testy', instances will be named, testy01, test02 etc
+axiom-fleet testy -i=10 --regions=NYC1,LON1,TOR1 # Initialize a fleet using round-robin region distribution  
+```
+
+---
 
-Modules are in `~/.axiom/modules/`
+# axiom-scan
+**Scanning using a fleet** :rocket: 
+*Modules are in `~/.axiom/modules/`*
 
 ```bash
 axiom-select 'fleet*' # fleets should be already selected, but just in case, select can be a good idea
@@ -196,21 +220,11 @@ axiom-scan ips.txt -m nmap -oX full -p- -T5 -sV --script=vulners # Will create
 
 axiom-scan ips.txt -m masscan -oG masscan.txt # Run masscan
 ```
-
 ---
 
-## Switch to a new region
-
-```bash
-axiom-region ls # lists regions
-axiom-region select <region> # select region
-
-axiom-region select ams2
-```
 
----
-
-## Execute a command against an Instance
+# axiom-exec
+**Execute a command against an Instance** :robot:
 
 ```bash
 axiom-exec '<command>' '<instance>' # Execute a command against an instance
@@ -219,4 +233,4 @@ axiom-exec '<command>' '<instance>' -q --cache  # Execute silent, just show comm
 
 axiom-exec 'nmap -T5 navisec.io' 'testy01' -q --cache  # Example
 axiom-execb 'nmap -T5 navisec.io' 'testy01' -q --cache
-```
+```