rayvn CLI

Manage shared bash libraries and executables.

Usage: rayvn COMMAND [PROJECT] [PROJECT...] <options>

Commands

    test              Run tests.
    build             Run nix build.
    theme             Select theme.
    new TYPE NAME     Create a new project/script/library/test with the specified NAME.
    libraries         List libraries.
    functions         List public functions.
    register          Register a project.
    release           Create a new release.
    index             Generate function indexes and Jekyll docs.

Use COMMAND --help for any additional details. PROJECT defaults to 'rayvn' if not specified.

Options:

    -h, --help        Print this help message and exit.
    -v                Print the version and exit.
    --version         Print the version with release date and exit.

Commands

test

rayvn test [PROJECT] [PROJECT...] [TEST-NAME] [TEST-NAME...] [--nix] [--all]

build

rayvn build [PROJECT] [PROJECT...]

theme

Interactive theme selector. Launches an arrow-key navigation prompt to choose between available themes.

new

rayvn new project|script|library|test NAME [--local]

libraries

project 'rayvn'
    central -> /Users/phoggy/dev/rayvn/lib/central.sh
    config -> /Users/phoggy/dev/rayvn/lib/config.sh
    core -> /Users/phoggy/dev/rayvn/lib/core.sh
    debug -> /Users/phoggy/dev/rayvn/lib/debug.sh
    deps -> /Users/phoggy/dev/rayvn/lib/deps.sh
    index -> /Users/phoggy/dev/rayvn/lib/index.sh
    oauth -> /Users/phoggy/dev/rayvn/lib/oauth.sh
    process -> /Users/phoggy/dev/rayvn/lib/process.sh
    prompt -> /Users/phoggy/dev/rayvn/lib/prompt.sh
    release -> /Users/phoggy/dev/rayvn/lib/release.sh
    secrets -> /Users/phoggy/dev/rayvn/lib/secrets.sh
    spinner -> /Users/phoggy/dev/rayvn/lib/spinner.sh
    terminal -> /Users/phoggy/dev/rayvn/lib/terminal.sh
    test-harness -> /Users/phoggy/dev/rayvn/lib/test-harness.sh
    test -> /Users/phoggy/dev/rayvn/lib/test.sh
    theme -> /Users/phoggy/dev/rayvn/lib/theme.sh

functions

rayvn.up functions

    _collectUnknownFunctionNames
    _loadRayvnLibrary
    require 

rayvn functions

    _printLibraries
    _printLibrary
    _printProject
    _printProjectLibrary
    addIfRayvnExecutable 
    assertSingleProject 
    copyFileAndSubstituteVars 
    create 
    createLibrary 
    createProject 
    createScript 
    createTest 
    forEachLibrary 
    forEachProject 
    getFunctions 
    getProjectRoot 
    indexDocs 
    init 
    listFunctions 
    listLibraries 
    listProjects 
    main 
    nixBuild 
    parseArgs 
    printUsage 
    printVersion 
    registerProject 
    releaseProject 
    remindIfNotInPath 
    runTests 
    theme 
    traceUp 
    traceUpInit 
    traceUpStack 
    traceUpVar 
    usage 

rayvn/core functions

    _ensureRayvnTempDir
    _init_colors
    _init_noColors
    _init_theme
    _onRayvnExit
    _onRayvnHup
    _onRayvnInt
    _onRayvnTerm
    _restoreTerminal
    _setFileSystemVar
    addExitHandler 
    allNewFilesUserOnly 
    appendVar 
    assertCommand 
    assertDirectory 
    assertFile 
    assertFileDoesNotExist 
    assertFileExists 
    assertIsInteractive 
    assertPathWithinDirectory 
    assertValidFileName 
    assertVarDefined 
    baseName 
    binaryPath 
    bye 
    configDirPath 
    containsAnsi 
    copyMap 
    dirName 
    elapsedEpochSeconds 
    ensureDir 
    epochSeconds 
    error 
    executeWithCleanVars 
    fail 
    header 
    indexOf 
    invalidArgs 
    isMemberOf 
    makeDir 
    makeTempDir 
    makeTempFifo 
    makeTempFile 
    maxArrayElementLength 
    numericPlaces 
    openUrl 
    padString 
    parseOptionalArg 
    printNumber 
    printStack 
    projectVersion 
    randomHexChar 
    randomInteger 
    redStream 
    repeat 
    replaceRandomHex 
    rootDirPath 
    secureEraseVars 
    setDebug 
    setDirVar 
    setFileVar 
    show 
    stackTrace 
    stripAnsi 
    tempDirPath 
    timeStamp 
    trim 
    varIsDefined 
    warn 
    withDefaultUmask 
    withUmask 

register

rayvn register PROJECT [--remove] 

release

rayvn release [PROJECT | --repo 'my-account/my-repo'] VERSION 

index

rayvn index [-o FILE] [-c FILE] [--no-compact] [--no-hash] [--hash-file FILE] [--docs DIR] [--publish]