yconn-1.1.0 is not a library.

yconn

SSH connection manager CLI — manage named SSH connections across teams and projects with a layered, git-friendly config system.

Connections live in YAML files at three layers (project, user, system). Higher layers override lower ones on name collision. When a Docker image is configured, yconn re-invokes itself inside the container so SSH keys can be pre-baked into an image rather than distributed to individual machines.

Installation

Arch Linux (AUR)

yay -S yconn

Debian / Ubuntu

Download the latest .deb from the releases page and install:

sudo dpkg -i yconn_0.1.0_amd64.deb

From source

cargo build --release --target x86_64-unknown-linux-musl

The compiled binary is placed at target/x86_64-unknown-linux-musl/release/yconn.

Usage

yconn [OPTIONS] COMMAND

Commands

Command	Description
`yconn list`	List all connections across all layers
`yconn connect <name>`	Connect to a named host
`yconn show <name>`	Show resolved config for a connection (no secrets printed)
`yconn add`	Interactive wizard to add a connection to a chosen layer
`yconn edit <name>`	Open the connection's source config file in `$EDITOR`
`yconn remove <name>`	Remove a connection (prompts for layer if ambiguous)
`yconn init`	Scaffold a `<group>.yaml` in `.yconn/` in the current directory
`yconn config`	Show active config files, their paths, and Docker status
`yconn group list`	Show all groups found across all layers
`yconn group use <name>`	Set the active group
`yconn group clear`	Revert to the default group (`connections`)
`yconn group current`	Print the active group name and resolved config file paths

Global flags

Flag	Description
`--layer system\|user\|project`	Target a specific layer for `add`, `edit`, `remove`
`--all`	Include shadowed entries in `yconn list`
`--verbose`	Print config loading, merge decisions, and full Docker invocation
`--no-color`	Disable colored output

Quick start

# Scaffold a project config in the current directory
yconn init

# Add a connection interactively
yconn add

# List all connections
yconn list

# Connect
yconn connect prod-web

# Switch to a named group
yconn group use work
yconn config

Config file format

version: 1

# Optional: re-invoke inside Docker so SSH keys stay in the image
docker:
  image: ghcr.io/myorg/yconn-keys:latest
  pull: missing   # "always" | "missing" (default) | "never"
  args:
    - "--network=host"

connections:
  prod-web:
    host: 10.0.1.50
    user: deploy
    port: 22
    auth: key
    key: ~/.ssh/prod_deploy_key
    description: "Primary production web server"
    link: https://wiki.internal/servers/prod-web

  staging-db:
    host: staging.internal
    user: dbadmin
    auth: password
    description: "Staging database server"

Config files are loaded from (highest to lowest priority):

Layer	Path (default group)	Notes
project	`.yconn/connections.yaml`	Lives in git — no credentials
user	`~/.config/yconn/connections.yaml`	Private to local user
system	`/etc/yconn/connections.yaml`	Org-wide, sysadmin-managed

The active group (set with yconn group use <name>) changes which filename is loaded from each layer. Switching to group work loads work.yaml from each layer instead.

Development

make build    # compile (musl static binary)
make test     # run tests
make lint     # cargo fmt --check + clippy
make docs     # generate docs/man/yconn.1 via pandoc
make release  # tag and trigger release pipeline

See man yconn for full documentation after make docs.

yconn 1.1.0