cli

README

Abbey CLI

An interactive way to set up Abbey. Built on Go with Cobra & BubbleTea.

The Abbey CLI will

• Pull existing examples
• Guide you on how to configure the example - such as setting the time expiry for your access policies
• Commit and deploy your changes to GitHub

Prerequisites

Before running the CLI, you must have

• An Abbey account
  • You can create one at app.abbey.io
• A GitHub account

Installing

You can install the CLI via

1. Cloning this repo
2. Building it via go build -o abbey main.go, or if you'd like to make it accessible everywhere go build -o $GOPATH/bin/abbey

Interactive Mode

You can run the CLI in interactive mode simply by running ./abbey init and it will guide you the rest of the way.

Flags

There are a number of flags available as well to speed things up. You can view the full list by running ./abbey init --help

./abbey init --help
Initializes an Abbey example


Usage:

  abbey init [flags]


Flags:

  -a, --accessOutput string   Location of Access Output
  -h, --help                  help for init
      --repo string           Git repo name in the format github-username/repo-name
  -r, --reviewer string       Abbey email address of the reviewer
  -t, --timeExpiry string     Time expiry of permissions

Need help?

If you have any questions along the way, feel free to get in touch - we'd love to chat with you

• Join our Slack
• Email us at hello@abbey.io
• Post a Github Issue

Documentation

Overview

Copyright © 2023 NAME HERE <EMAIL ADDRESS>