oye - common file example copier

oye will create a documented example of a common repository or project file in the directory where it is run.

Usage

The following installs oye and creates an example README.md in the current directory:

npm install -g oye
oye readme

Purpose

oye espouses relative speed and documentation. It is not a file generator and does not use templates. It is not intended for multiple files with directory structures. It is intended to be a lightweight alternative to yeoman. Your examples should be well documented and assume that the individual using it may not be well-versed in this type of file. It is easier to delete what you don't need, or what you consider verbose, than searching through man or goggling what you do need.

Customization

oye comes with some common examples, but also allows you to define your own in ~/.oye. Remember to update ~/.oye/.oye.json with the names and filenames of your own examples. Any custom .oye.json will be merged with the default version, with the custom entries taking precedence.

Example .oye.json file:

{
  "examples": {
    "example": "example.md",
    "another-example": {
      "description": "optional description of example",
      "source": "sourceExampleFile.md",
      "target": "exampleFile.md"
    }
  }
}

You may also have a single-level of subdirectories of ~/.oye with their own .oye.json. These entries are namespaced with the directory name to avoid conflicts.