README
¶
AzBrowse
An interactive CLI for browsing azure resources, inspired by resources.azure.com
Quick Start
Simply download the binary suitable for your machine, from the release page, and execute it.
Status
It's an MVP to prove out the use case. Basic navigation and operations with a boltdb based cache for expensive (slow) API calls.
Currently I'm using it every day but it is experimental so use with caution on a production environment!!
Install
Grab the binaries from the release page or for MacOS and Linux run this script
curl -sSL https://raw.githubusercontent.com/lawrencegripper/azbrowse/master/scripts/install_azbrowse.sh | sudo sh
You may need to reload your terminal to pick up azbrowse after the script completes.
Usage
Navigation
| Key | Does |
|---|---|
| ↑/↓ | Select resource |
| Backspace | Go back |
| ENTER | Expand/View resource |
Operations
| Key | Does | |
|---|---|---|
| CTRL+E | Toggle Browse JSON | For longer responses you can move the cursor to scroll the doc |
| CTRL+o (o for open) | Open Portal | Opens the portal at the currently selected resource |
| DEL: | Delete resource | The currently selected resource will be deleted (Requires double press to confirm) |
| CTLT+F: | Toggle Fullscreen | Gives a fullscreen view of the JSON for smaller terminals |
| CTLT+S: | Save JSON to clipboard | Saves the last JSON response to the clipboard for export |
| CTLT+A: | View Actions for resource | This allows things like ListKeys on storage or Restart on VMs |
Debugging
Running azbrowse --debug will start an in-memory collector for the opentracing and a GUI to browse this at http://localhost:8700. You can use this to look at tracing information output by azbrowse as it runs.
Developing
Environment Setup
First, clone this repository. azbrowse is written in Go and so you will want to set up your Go development environment first. If this is your first time, the offical install guide is probably a good place to start. Make sure you have GOPATH/bin in your PATH, using the instructions here as guidance on doing that.
In addition to installing Go, there are a couple of tool dependencies you'll need. These are:
You can install these yourself following the instructions on their github pages, or you can run...
make setup
This runs the script scripts/install_dev_tools.sh, which will install these tools for you.
Building
With your Go development environment set up, use make to build azbrowse.
Take a look at the Makefile yourself, but the main rules are:
Run Tests and Build
make build
Install Local Development Build
make install
Run Travis-CI build locally
make ci-docker
To run the full Travis-CI locally, you need to have the TRAVIS_BUILD_NUMBER environment variable defined, so running it as follows may be easier:
TRAVIS_BUILD_NUMBER=0.1 make ci-docker
Plans
Issues on the repository track plans, I'd love help so feel free to comment on an issue you'd like to work on and we'll go from there.
Directories