getme

README

getme

An easy, fast and portable way to retrieve files somewhere.

Work In Progress

Things haven't gotten stable yet 👷

getme works by traversing a list of directories looking for the file you want. As soon as the file is found, it is copied to your current working directory. It can also retrieve the file from a remote source, such as Github. In short, it is given to you.

1. features
2. installation
3. usage
4. configuration
5. utilities
6. license

features:

• compiles templates with custom values from you
• allows path prefixes, which in turn allows files with same name
• no configuration
• versioned
• programmatic adding of predefined paths e.g. Dropbox folder
• aware of hosted git repos e.g. Github
• works on Windows too. 😓

installation:

Using Go tools:

⇒ go get github.com/GochoMugo/getme

usage:

local (getting files from your disk):

⇒ getme local LICENSE-MIT .jshintrc

This will make getme look for the files LICENSE-MIT and .jshintrc in the configured template directories. See adding template directories

remote:

getting files from a Url:

getme remote --url https://gochomugo.github.io/feed.xml feed.xml

getting files from Github:

⇒ getme remote --github GochoMugo/getme master lib/getme.go

GochoMugo/getme is a Github shorthand, master is the repo's branch, lib/getme.go is the path to the target file from the root of the repo.

help information:

⇒ getme help

configuration:

getme can be used as is, without any configurations. It will automatically look for files in directory .getme in your Home directory.

add template directories:

You may want it to look for files in other directories. This is possible using the $GETME_PATH variable.

On *nix machines, you could add the following line to ~/.bashrc (or equivalent file):

export GETME_PATH="path/to/some/dir:another/path"

On Windows machines, you need to use the Control panel.

utilities:

To increase productivity (every boss likes that), I've added some utilities to the utils directory that can be quite useful. These utilities may not be as portable as the getme program itself but we shall try our best.

license:

The MIT License (MIT)

Copyright (c) 2015 GochoMugo mugo@forfuture.co.ke