Browse Source

[docs] Added descriptions of commands

pull/1/head
Muthu Kumar 7 years ago
parent
commit
961ab8f74c
  1. 26
      scripts/README.md

26
scripts/README.md

@ -4,7 +4,7 @@ I made this script for my own convenience. Use at your own risk. Plenty of comme
## Install ## Install
Add this script to your `~/.bashrc` or `~/.zshrc`: Automatically add this script to your `~/.bashrc` or `~/.zshrc`:
```bash ```bash
mkdir ~/.mkr && curl https://raw.githubusercontent.com/MKRhere/wiki/master/scripts/mkr.sh -o ~/.mkr/mkr.sh mkdir ~/.mkr && curl https://raw.githubusercontent.com/MKRhere/wiki/master/scripts/mkr.sh -o ~/.mkr/mkr.sh
@ -14,6 +14,9 @@ echo "source ~/.mkr/mkr.sh" >> ~/.bashrc
# or zsh # or zsh
echo "source ~/.mkr/mkr.sh" >> ~/.zshrc echo "source ~/.mkr/mkr.sh" >> ~/.zshrc
# To start using right away without waiting for shell restart
source ~/.mkr/mkr.sh
# updating script # updating script
mkr-update mkr-update
``` ```
@ -21,19 +24,20 @@ mkr-update
## Commands ## Commands
- General - General
- `cls` - `cls` : Clears screen
- `clip` : Copies to clipboard
- apt - apt
- `i <package-name>` - `i <package-names...>` : Accepts prompts and installs packages
- `install <package-name>` - `install <package-names...>` : Installs packages without auto-accepting
- `update` - `update` : Equivalent to `apt-get update`
- `purge <package-name>` - `purge <package-names...>` : Removes packages
- `ar` / `autoremove` - `ar` / `autoremove` : Equivalent to `apt autoremove`
- Directories - Directories
- `mk <dir>` - `mk <dir>` : Makes dir and changes into it
- `rmd [dir]` - `rmd [dir]` : Removes current directory and moves up OR removes directory by given name
- git - git
- `commit <commit-message>` - `commit <commit-message>` : Adds all untracked files and commits them
- `push <commit-message> [remote branch]` - `push <commit-message> [remote branch]` : Adds all untracked files, commits and pushes them
- systemctl - systemctl
- `status <daemon>` - `status <daemon>`
- `start <daemon>` - `start <daemon>`

Loading…
Cancel
Save