Update README.md

README.md

@@ -14,13 +14,14 @@ Autorestic is a wrapper around the amazing [restic](https://restic.net/). While
 - Simple interface
 - Fully encrypted
 
-###### 📒 Docs
+### 📒 Docs
 
-- [Locations](#-locations)
-  - [Pruning & Deleting old files](#pruning-and-snapshot-policies)
-  - [Excluding files](#excluding-filesfolders)
-  - [Hooks](#before--after-hooks)
-- [Backends](#-backends)
+* [Locations](#-locations)
+  * [Pruning & Deleting old files](#pruning-and-snapshot-policies)
+  * [Excluding files](#excluding-filesfolders)
+  * [Hooks](#before--after-hooks)
+* [Backends](#-backends)
+* [Commands](#-commands)
 
 ## 🛳 Installation
 
@@ -78,19 +79,10 @@ autorestic backup -a
 
 ### 📼 Restore
 
-```
-autorestic restore -a --to /path/where/to/restore
-```
-
-This will restore all the locations to the selected target. If for one location there are more than one backends specified autorestic will take the first one.
-
-Lets see a more realistic example (from the config above)
 ```
 autorestic restore -l home --from hdd --to /path/where/to/restore
 ```
 
-This will restore the location `home` to the `/path/where/to/restore` folder and taking the data from the backend `hdd`
-
 ### 📲 Updates
 
 Autorestic can update itself! Super handy right? Simply run `autorestic update` and we will check for you if there are updates for restic and autorestic and install them if necessary.
@@ -233,6 +225,104 @@ backends:
     B2_ACCOUNT_KEY: backblaze_account_key
 ```
 
+## 👉 Commands
+
+* [info](#info)
+* [check](#check)
+* [backup](#backup)
+* [forget](#forget)
+* [restore](#restore)
+* [exec](#exec)
+* [intall](#install)
+* [uninstall](#uninstall)
+* [upgrade](#upgrade)
+
+
+### Info
+
+```
+autorestic info
+```
+
+Shows all the information in the config file. Usefull for a quick overview of what location backups where.
+
+Pro tip: if it gets a bit long you can read it more easily with `autorestic info | less` 😉
+
+### Check
+
+```
+autorestic check [-b, --backend]  [-a, --all]
+```
+
+Checks the backends and configures them if needed. Can be applied to all with the `-a` flag or by specifying one or more backends with the `-b` or `--backend` flag.
+
+
+### Backup
+
+```
+autorestic backup [-l, --location] [-a, --all]
+```
+
+Performes a backup of all locations if the `-a` flag is passed. To only backup some locations pass one or more `-l` or `--location` flags.
+
+
+### Restore
+
+```
+autorestic restore [-l, --location] [--from backend] [--to <out dir>]
+```
+
+This will restore all the locations to the selected target. If for one location there are more than one backends specified autorestic will take the first one.
+
+Lets see a more realistic example (from the config above)
+```
+autorestic restore -l home --from hdd --to /path/where/to/restore
+```
+
+This will restore the location `home` to the `/path/where/to/restore` folder and taking the data from the backend `hdd`
+
+```
+autorestic restore
+```
+
+Performes a backup of all locations if the `-a` flag is passed. To only backup some locations pass one or more `-l` or `--location` flags.
+
+### Forget
+
+
+```
+autorestic forget [-l, --location] [-a, --all] [--dry-run]
+```
+
+This will prune and remove old data form the backends according to the [keep policy you have specified for the location](#pruning-and-snapshot-policies)
+
+The `--dry-run` flag will do a dry run showing what would have been deleted, but won't touch the actual data.
+
+
+### Exec
+
+```
+autorestic exec [-b, --backend]  [-a, --all] <command> -- [native options]
+```
+
+This is avery handy command which enables you to run any native restic command on desired backends. An example would be listing all the snapshots of all your backends:
+
+```
+autorestic exec -a -- snapshots
+```
+
+#### Install
+
+Installs both restic and autorestic
+
+#### Uninstall 
+
+Uninstall both restic and autorestic
+
+#### Upgrade
+
+Upgrades both restic and autorestic automagically
+
 ## Contributors
 
 This amazing people helped the project!

package.json

@@ -19,6 +19,7 @@
 		"clitastic": "0.0.1",
 		"colors": "^1.3.3",
 		"js-yaml": "^3.13.1",
-		"minimist": "^1.2.0"
+		"minimist": "^1.2.0",
+		"uhrwerk": "^1.0.0"
 	}
-}
+}

src/autorestic.ts

@@ -25,7 +25,7 @@ export const { _: commands, ...flags } = minimist(process.argv.slice(2), {
 	string: ['l', 'b'],
 })
 
-export const VERSION = '0.9'
+export const VERSION = '0.10'
 export const INSTALL_DIR = '/usr/local/bin'
 export const VERBOSE = flags.verbose
 

src/backup.ts

@@ -3,12 +3,21 @@ import { Writer } from 'clitastic'
 import { config, VERBOSE } from './autorestic'
 import { getEnvFromBackend } from './backend'
 import { Locations, Location } from './types'
-import { exec, ConfigError, pathRelativeToConfigFile, getFlagsFromLocation, makeArrayIfIsNot, execPlain } from './utils'
+import {
+	exec,
+	ConfigError,
+	pathRelativeToConfigFile,
+	getFlagsFromLocation,
+	makeArrayIfIsNot,
+	execPlain,
+	MeasureDuration, fill,
+} from './utils'
 
 
 
 export const backupSingle = (name: string, to: string, location: Location) => {
 	if (!config) throw ConfigError
+	const delta = new MeasureDuration()
 	const writer = new Writer(name + to.blue + ' : ' + 'Backing up... ⏳')
 
 	const backend = config.backends[to]
@@ -21,12 +30,12 @@ export const backupSingle = (name: string, to: string, location: Location) => {
 	)
 
 	if (VERBOSE) console.log(cmd.out, cmd.err)
-	writer.done(name + to.blue + ' : ' + 'Done ✓'.green)
+	writer.done(`${name}${to.blue} : ${'Done ✓'.green} (${delta.finished(true)})`)
 }
 
 export const backupLocation = (name: string, location: Location) => {
 	const display = name.yellow + ' ▶ '
-	const filler = new Array(name.length + 3).fill(' ').join('')
+	const filler = fill(name.length + 3)
 	let first = true
 
 	if (location.hooks && location.hooks.before)

src/forget.ts

@@ -3,7 +3,14 @@ import { Writer } from 'clitastic'
 import { config, VERBOSE } from './autorestic'
 import { getEnvFromBackend } from './backend'
 import { Locations, Location, Flags } from './types'
-import { exec, ConfigError, pathRelativeToConfigFile, getFlagsFromLocation, makeArrayIfIsNot } from './utils'
+import {
+	exec,
+	ConfigError,
+	pathRelativeToConfigFile,
+	getFlagsFromLocation,
+	makeArrayIfIsNot,
+	fill,
+} from './utils'
 
 
 
@@ -35,7 +42,7 @@ export const forgetSingle = (name: string, to: string, location: Location, dryRu
 
 export const forgetLocation = (name: string, backup: Location, dryRun: boolean) => {
 	const display = name.yellow + ' ▶ '
-	const filler = new Array(name.length + 3).fill(' ').join('')
+	const filler = fill(name.length + 3)
 	let first = true
 
 	for (const t of makeArrayIfIsNot(backup.to)) {

src/handlers.ts

@@ -8,6 +8,7 @@ import { config, INSTALL_DIR, VERSION } from './autorestic'
 import { checkAndConfigureBackends, getBackendsFromLocations, getEnvFromBackend } from './backend'
 import { backupAll } from './backup'
 import { forgetAll } from './forget'
+import showAll from './info'
 import { Backends, Flags, Locations } from './types'
 import {
 	checkIfCommandIsAvailable,
@@ -138,6 +139,9 @@ const handlers: Handlers = {
 			console.log(out, err)
 		}
 	},
+	async info() {
+		showAll()
+	},
 	async install() {
 		try {
 			checkIfResticIsAvailable()
@@ -240,6 +244,7 @@ export const help = () => {
 		`\n  -c, --config                                                          Specify config file. Default: .autorestic.yml` +
 		'\n' +
 		'\nCommands:'.yellow +
+		'\n  info                                                                  Show all locations and backends' +
 		'\n  check    [-b, --backend]  [-a, --all]                                 Check backends' +
 		'\n  backup   [-l, --location] [-a, --all]                                 Backup all or specified locations' +
 		'\n  forget   [-l, --location] [-a, --all] [--dry-run]                     Forget old snapshots according to declared policies' +

src/info.ts

@@ -0,0 +1,28 @@
+import { config } from './autorestic'
+import { ConfigError, fill, treeToString } from './utils'
+
+
+
+const showAll = () => {
+	if (!config) throw ConfigError
+
+	console.log('\n\n' + fill(32, '_') + 'LOCATIONS:'.underline)
+	for (const [key, data] of Object.entries(config.locations)) {
+		console.log(`\n${key.blue.underline}:`)
+		console.log(treeToString(
+			data,
+			['to:', 'from:', 'hooks:', 'options:'],
+		))
+	}
+
+	console.log('\n\n' + fill(32, '_') + 'BACKENDS:'.underline)
+	for (const [key, data] of Object.entries(config.backends)) {
+		console.log(`\n${key.blue.underline}:`)
+		console.log(treeToString(
+			data,
+			['type:', 'path:', 'key:'],
+		))
+	}
+}
+
+export default showAll

src/utils.ts

@@ -3,6 +3,8 @@ import { spawnSync, SpawnSyncOptions } from 'child_process'
 import { randomBytes } from 'crypto'
 import { createWriteStream } from 'fs'
 import { dirname, isAbsolute, resolve } from 'path'
+import { Duration, Humanizer } from 'uhrwerk'
+
 import { CONFIG_FILE } from './config'
 import { Location } from './types'
 
@@ -113,3 +115,44 @@ export const getFlagsFromLocation = (location: Location, command?: string): stri
 }
 
 export const makeArrayIfIsNot = <T>(maybeArray: T | T[]): T[] => Array.isArray(maybeArray) ? maybeArray : [maybeArray]
+
+export const fill = (length: number, filler = ' '): string => new Array(length).fill(filler).join('')
+
+export const capitalize = (string: string): string => string.charAt(0).toUpperCase() + string.slice(1)
+
+export const treeToString = (obj: Object, highlight = [] as string[]): string => {
+	let cleaned = JSON.stringify(obj, null, 2)
+		.replace(/[{}"\[\],]/g, '')
+		.replace(/^ {2}/mg, '')
+		.replace(/\n\s*\n/g, '\n')
+		.trim()
+
+	for (const word of highlight)
+		cleaned = cleaned.replace(word, capitalize(word).green)
+
+	return cleaned
+}
+
+
+export class MeasureDuration {
+	private static Humanizer: Humanizer = [
+		[d => d.hours() > 0, d => `${d.hours()}h ${d.minutes()}min`],
+		[d => d.minutes() > 0, d => `${d.minutes()}min ${d.seconds()}s`],
+		[d => d.seconds() > 0, d => `${d.seconds()}s`],
+		[() => true, d => `${d.milliseconds()}ms`],
+	]
+
+	private start = Date.now()
+
+
+	finished(human?: false): number
+	finished(human?: true): string
+	finished(human?: boolean): number | string {
+		const delta = Date.now() - this.start
+
+		return human
+			? new Duration(delta, 'ms').humanize(MeasureDuration.Humanizer)
+			: delta
+	}
+
+}