README.md

ok

Install with Homebrew

A Homebrew formula is included at ./Formula/ok.rb.

brew tap oslokommune/ok https://github.com/oslokommune/ok
brew install ok

If you watch the project (Watch → Custom → Releases) you can easily upgrade to the latest version when notified:

brew update
brew upgrade ok

To uninstall:

brew uninstall ok
brew untap oslokommune/ok

Usage

The `ok` tool helps you to create a fresh Terraform environment (like prod or development) and configure it to use remote state storage.

Your environment is configured using a `packages.yml` file. This file is a package manifest listing the components from Golden Path that you wish to use. An example can be found in the `pirates-iac` repository.

Usage:
  ok [command]

Available Commands:
  aws          Group of AWS related commands.
  completion   Generate the autocompletion script for the specified shell
  forward      Starts a port forwarding session to a database.
  help         Help about any command
  pkg          Group of package related commands for managing Boilerplate packages.
  version      Prints the version of the `ok` tool and the current latest version available.

Flags:
      --config string   config file (default is /Users/anders/.config/ok/config.yml)
  -h, --help            help for ok

Use "ok [command] --help" for more information about a command.

Enable tab completions in terminal

ok comes bundled with tab completions, but you may need to instruct your terminal to load them!

When installing from Brew many programs are bundled with their own completions, you can make sure your terminal loads these completions by default.

See the full description here: https://docs.brew.sh/Shell-Completion

Using zsh with oh-my-zsh

Add the following line to your ~/.zshrc before you source oh-my-zsh.sh

FPATH="$(brew --prefix)/share/zsh/site-functions:${FPATH}"

Using zsh without oh-my-zsh

Add the following lines to your ~/.zshrc

if type brew &>/dev/null
then
  FPATH="$(brew --prefix)/share/zsh/site-functions:${FPATH}"

  autoload -Uz compinit
  compinit
fi

Using bash

Add the following lines to your ~/.bash_profile (if that does not exist, add it to ~/.profile)

if type brew &>/dev/null
then
  HOMEBREW_PREFIX="$(brew --prefix)"
  if [[ -r "${HOMEBREW_PREFIX}/etc/profile.d/bash_completion.sh" ]]
  then
    source "${HOMEBREW_PREFIX}/etc/profile.d/bash_completion.sh"
  else
    for COMPLETION in "${HOMEBREW_PREFIX}/etc/bash_completion.d/"*
    do
      [[ -r "${COMPLETION}" ]] && source "${COMPLETION}"
    done
  fi
fi

Manually sourcing completions

If you do not use, or do not want to enable completions by default from Brew, you have the option to source the completions offered by ok manually.

Add one of the lines below to your ~/.zshrc or ~/.bash_profile

Bash:

source <(ok completions bash)

Zsh:

source <(ok completions zsh)