baker

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 7, 2024 License: MIT Imports: 6 Imported by: 0

README

Baker

A simple file backup/copy utility. Baker automates the simple yet incredibly common task of creating backup copies of files and directories, such as cp file file.bak. Doing this is not hard, but all that typing can get annoying, especially if you do it often!

Installation

First, ensure that Go is installed, and that its bin/ directory is inside your $PATH. For example in .zshrc:

export PATH="$PATH:$HOME/go/bin"

Then, run the following command to install the binary:

go install github.com/ficcdaf/baker@latest

To uninstall Baker, simply delete the binary:

# If you Go bin directory is in $HOME:
rm $HOME/go/bin/baker

Usage

Using Baker is simple. It takes a single argument, which can be a file or a directory. It will create a copy of its target and append to its extension .bak if it's a normal file, and .d.bak if it's a directory. By default, Baker will not overwrite a backup that already exists, but you may force it with the -f flag.

# Creates myfile.txt.bak
baker myfile.txt
# Creates mydirectory.d.bak
baker mydirectory
# To overwrite an existing backup, use the -f flag:
baker -f myfile.txt
baker -f mydirectory
# To view help:
baker -h

Why?

This could have been a very simple shell alias or function. But I like programming, I like Go, so I decided to make utility instead. There's no reason not to release your own commands and utilities, even if they're dead simple! It's also a great way to practice dealing with GitHub and managing software releases & packaging.

Roadmap

  • -n flag to create a backup with a unique name if the file already exists.
  • Accept multiple input arguments.
  • Specify output location.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL