Skip to content

shoehorn-dev/shoehorn-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shoehorn CLI

Go Report Card Release

Command-line interface for the Shoehorn Intelligent Developer Platform. Browse your service catalog, manage governance actions, view GitOps resources, explore teams and ownership, run Forge workflows, manage addons, and more — all from the terminal with a rich interactive TUI.

Installation

Build from source

go build -o shoehorn.exe ./cmd/shoehorn

Homebrew (macOS / Linux)

brew tap shoehorn-dev/tap
brew install shoehorn

Mise (macOS / Linux / Windows)

Add to your mise.toml or ~/.config/mise/config.toml:

[tools."github:shoehorn-dev/shoehorn-cli"]
version = "latest"
exe = "shoehorn"

Then run:

mise install

Windows: Ensure the mise shims directory is in your PATH:

# Add to your PowerShell profile (one-time setup):
Add-Content $PROFILE '$env:PATH = "$env:LOCALAPPDATA\mise\shims;$env:PATH"'

Scoop (Windows)

scoop bucket add shoehorn https://github.com/shoehorn-dev/scoop-bucket
scoop install shoehorn

Manual download

Download the binary for your platform from Releases, extract it, and add to your PATH.

Quick Start

# 1. Authenticate
shoehorn auth login --server http://localhost:8080 --token shp_your_token_here

# 2. Verify your identity
shoehorn whoami

# 3. Explore the catalog
shoehorn get entities
shoehorn search "payment"
shoehorn get entity payment-service --scorecard

Documentation

Guide Description
Authentication PAT login, status, logout
Catalog & Search Entities, teams, users, groups, ownership, scorecards, K8s, GitOps
Forge Workflows Molds, execute workflows, manage runs
Governance Actions, dashboard
Declarative Operations Apply, diff, create/update/delete entities
Addons Install, publish, develop addons
Manifest Tools Validate and convert manifests
CI/CD Checks Gate pipelines on catalog quality
Configuration Config file, profiles, global flags, shell completion, TUI controls
Troubleshooting Common issues and debug mode
Architecture Project structure

License

MIT

Packages

 
 
 

Contributors

Languages