Skip to content
/ bbb Public
forked from achetronic/bbb

A super UX friendly CLI to make daily connections through H.Boundary easy to do

License

Notifications You must be signed in to change notification settings

dfradehubs/bbb

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BBB (Boundary But Better)

BBB (Main) logo.

GitHub go.mod Go version (subdirectory of monorepo) GitHub

YouTube Channel Subscribers GitHub followers X (formerly Twitter) Follow

A super UX friendly CLI to make daily connections through H.Boundary easy to do.

It covers common auth, targets listing, target connections by SSH, Kubernetes, etc

BBB (Main) logo.

Motivation

Original H.Boundary CLI is designed to manage every administration aspect of Boundary (even the hardest ones), but its usage is not friendly, and some flows are even bugged. This makes original CLI not usable on a daily basis.

This CLI wraps original CLI, fixing things such as UX and bugs on top of Boundary CLI, empowering people to use Boundary in an easy and reliable way.

Environment Variables

Only few parameters are managed by environment variables. They are described in the following table:

Name Description Default Example
BOUNDARY_ADDR Address where your H.Boundary instance is hosted - https://hashicorp-boundary.company.com

Quickstart

1. Install Hashicorp Boundary in your system

Go to the official installation docs and install it. If you are a super expert, just go to releases and chose a version

Don't worry, because BBB is able to detect if you have Boundary CLI installed (🧙‍♂️ MAGIC) and give you a direct link for downloading the most suitable package for your system.

2. Install BBB

We have prepared a one-liner installation script that detects your system and install the most suitable version for you. Just copy the next command and execute it on your terminal

curl -s -o /tmp/install.sh https://raw.githubusercontent.com/achetronic/bbb/master/extra/install.sh && bash /tmp/install.sh

If you prefer to download the binary on your own, simply chose a binary on releases page and download it

3. Use BBB CLI

# Hey! Remember to point to your H.Boundary controller
export BOUNDARY_ADDR="https://your-boundary.you-company.com/"


bbb auth

How to contribute

We are open to external collaborations for this project: improvements, bugfixes, whatever.

For doing it, open an issue to discuss the need of the changes, then:

  • Fork the repository
  • Make your changes to the code
  • Open a PR and wait for review

The code will be reviewed and tested (always)

We are developers and hate bad code. For that reason we ask you the highest quality on each line of code to improve this project on each iteration.

License

Copyright 2022.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Special mention

This project was done using IDEs from JetBrains. They helped us to develop faster, so we recommend them a lot! 🤓

JetBrains Logo (Main) logo.

About

A super UX friendly CLI to make daily connections through H.Boundary easy to do

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 85.3%
  • Shell 9.6%
  • Makefile 5.1%