Skip to content

simon-danielsson/reamake

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

reamake

A CLI application built for quickly creating folder structures and preparing
stems for mixing, mastering and production projects in Cockos Reaper

Crates.io version MIT License Last commit

FeaturesInstallUsageDependenciesLicense


Features

  • For designing your folder structures Reamake features its own scripting language with support for custom variables, striking a balance between flexibility and ease-of-use. Neovim plugin for syntax highlighting and such is available here.
  • Subcommands for normalizing, correcting and sorting raw audio stems in record-time (not implemented yet).

Install

cargo install reamake

Usage

CLI

Generate initialized reamake template file (without target dir, current directory is assumed):

reamake init <target dir>

Generate folder structure from template file (without target dir, current directory is assumed):

reamake -f <reamake template file> <target dir>

In your reamake template file you can set variables, and they can all be overridden through the CLI at your leisure. Just make sure that the variable you're overriding exists in you reamake file and that you're supplying the right kind of value! (e.g a folder variable override would need a filepath, a string variable would need a string and so on)

$ reamake ... -var variable="value"
$ reamake ... -v variable="value"
$ reamake ... --var variable="value"

Example:
$ reamake -f template.reamake --var stems="/Users/usr/Downloads/stems/" --var client="New Client" --var rpp="/Users/usr/music/templates/mix.rpp"

Display help and version information:

reamake help

Template file (.reamake)

The core workflow of Reamake consists of feeding the CLI with reamake template files. A reamake file (file with the .reamake extension) is divided up into three sections: variables, settings and hierarchy. This format accepts comments (prefixed with '#'), but comment lines should be separate from the parameter lines since doing otherwise could lead to undefined behaviour. For more details, read the comments in the example below!

Full example

# there are only three different datatypes to keep track of:

# 1: <string> - used for name variables

# 2: <file> - an empty generic file, where the extension in its name will specify the extension of the file once generated
# variables with the datatype <file> will inherit the same extension logic as a generic file, only that the contents of the file variable path supplied will be the contents of the file generated

# 3: <folder> - a generic folder
# variables with the datatype <folder> will inherit the contents of the folder specified in the variables section

variables [
    # built-in: date
    client: string = "client"
    project: string = "project"
    service: string = "mix"
    rpp: file = "/Users/usr/music/templates/mix.RPP"
    stems: folder = "/Users/usr/Downloads/stems_from_client/"
    # you can create any variables you want
    fruit: string = "banana"
]

settings [
    format_names: false
    format_date: "%d-%m-%Y"
]

hierarchy [
    folder "[$service] $client - $project, $date" {
        folder "project" {
            rpp "$project $date.RPP"
            file "$fruit notes.md"
        }

        # it's legal to add extra files/folders to a folder variable
        stems "stems" {
            file "todo.md"
        }

        folder "export" {
            folder "$fruit drafts" {}
        }
    }
]

Dependencies


License

This project is licensed under the MIT License.

About

A CLI application built for quickly creating folder structures and preparing stems for mixing, mastering and production projects in Cockos Reaper.

Topics

Resources

License

Stars

Watchers

Forks

Contributors