From 604a4ecde26491e870cb3374ba607af806655dab Mon Sep 17 00:00:00 2001 From: mirivlad Date: Sat, 6 Jun 2026 11:14:15 +0800 Subject: [PATCH] docs: clarify platform and repository status --- README.md | 18 +++++++++--------- cmd/root.go | 2 +- docs/guide.md | 12 ++++++------ docs/release.md | 2 +- internal/tui/help_screen.go | 2 +- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 920241d..611e4b5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # sshkeeper `sshkeeper` is a console manager for SSH profiles, secrets, and quick OpenSSH -launches. Primary target: Linux. macOS builds are available, and Windows builds -are experimental. It does not replace OpenSSH; it keeps connection metadata in a -local SQLite database, keeps passwords/passphrases in an encrypted vault, and -starts the system `ssh` client with the right options. +launches. Linux and macOS are the primary release targets; Windows builds are +experimental. It does not replace OpenSSH; it keeps connection metadata in a local +SQLite database, keeps passwords/passphrases in an encrypted vault, and starts +the system `ssh` client with the right options. ## sshkeeper is not Ansible @@ -34,7 +34,7 @@ port forwarding management. ### Build from source ```bash -git clone git@git.mirv.top:mirivlad/sshkeeper.git +git clone git@github.com:mirivlad/sshkeeper.git cd sshkeeper go build -o ~/.local/bin/sshkeeper . ``` @@ -52,8 +52,8 @@ Platform status: | Platform | Status | Notes | |----------|--------|-------| -| Linux | Primary target | `linux/amd64` and `linux/arm64` release tarballs are available. | -| macOS | Supported, needs verification on target machines | `darwin/amd64` and `darwin/arm64` release tarballs are available. Requires system `ssh` client. Homebrew formula planned. | +| Linux | Primary release target | `linux/amd64` and `linux/arm64` release tarballs are available. | +| macOS | Primary release target | `darwin/amd64` and `darwin/arm64` release tarballs are available. Requires system `ssh` client. Homebrew formula planned. | | Windows | Experimental | Requires OpenSSH Client available as `ssh.exe` in `PATH`. Password/key-passphrase PTY flows are not validated on Windows. | On Windows, install OpenSSH Client via Windows Optional Features or PowerShell: @@ -63,8 +63,8 @@ Add-WindowsCapability -Online -Name OpenSSH.Client~~~~0.0.1.0 ``` **Source repositories:** -- Main public: [github.com/mirivlad/sshkeeper](https://github.com/mirivlad/sshkeeper) -- Mirror/dev: `git@git.mirv.top:mirivlad/sshkeeper` +- Primary public repository: [github.com/mirivlad/sshkeeper](https://github.com/mirivlad/sshkeeper) +- Self-hosted mirror: `git@git.mirv.top:mirivlad/sshkeeper` ### Install from release (after v0.2.0 publication) diff --git a/cmd/root.go b/cmd/root.go index 9a73075..e4b9d58 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -22,7 +22,7 @@ var rootCmd = &cobra.Command{ Use: "sshkeeper", Short: "sshkeeper — SSH connection manager", Long: `sshkeeper is a console SSH connection manager. -Linux is the primary target; macOS builds are available and Windows is experimental. +Linux and macOS are primary release targets; Windows is experimental. It manages server profiles, secrets, and provides a convenient way to launch SSH sessions using the system OpenSSH client.`, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/docs/guide.md b/docs/guide.md index abc892f..408a2f1 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -18,7 +18,7 @@ ## Что такое sshkeeper -sshkeeper — это консольный менеджер SSH-подключений. Основная целевая платформа — Linux; сборки для macOS доступны, Windows-сборка пока экспериментальная. Он хранит профили серверов, секреты (пароли, фразы от ключей) и запускает системный `ssh` с нужными опциями. +sshkeeper — это консольный менеджер SSH-подключений. Основные релизные платформы — Linux и macOS; Windows-сборка пока экспериментальная. Он хранит профили серверов, секреты (пароли, фразы от ключей) и запускает системный `ssh` с нужными опциями. **Чем sshkeeper НЕ является:** - Это не Ansible — он не настраивает серверы и не пушит файлы @@ -42,7 +42,7 @@ sshkeeper — это консольный менеджер SSH-подключе **Исходники:** - Основной публичный репозиторий: [github.com/mirivlad/sshkeeper](https://github.com/mirivlad/sshkeeper) -- Зеркало/рабочий репозиторий: `git@git.mirv.top:mirivlad/sshkeeper` +- Self-hosted зеркало: `git@git.mirv.top:mirivlad/sshkeeper` --- @@ -51,7 +51,7 @@ sshkeeper — это консольный менеджер SSH-подключе ### Из исходников (основной способ) ```bash -git clone git@git.mirv.top:mirivlad/sshkeeper.git +git clone git@github.com:mirivlad/sshkeeper.git cd sshkeeper go build -o ~/.local/bin/sshkeeper . ``` @@ -69,8 +69,8 @@ go build -o ~/.local/bin/sshkeeper . | Платформа | Статус | Примечание | |-----------|--------|------------| -| Linux | Основная целевая платформа | Архивы `linux/amd64` и `linux/arm64`. | -| macOS | Сборки доступны, требуется проверка на целевых машинах | Архивы `darwin/amd64` и `darwin/arm64`, нужен системный `ssh`. Homebrew formula запланирована. | +| Linux | Основная релизная платформа | Архивы `linux/amd64` и `linux/arm64`. | +| macOS | Основная релизная платформа | Архивы `darwin/amd64` и `darwin/arm64`, нужен системный `ssh`. Homebrew formula запланирована. | | Windows | Experimental | Нужен OpenSSH Client как `ssh.exe` в `PATH`; password/key-passphrase PTY-сценарии на Windows пока не подтверждены. | На Windows OpenSSH Client можно установить через Windows Optional Features или PowerShell: @@ -206,7 +206,7 @@ sshkeeper — Full Help What is sshkeeper sshkeeper is a console SSH connection manager. - Linux is the primary target; macOS builds are available and Windows is experimental. + Linux and macOS are primary release targets; Windows is experimental. It stores server profiles, secrets, and launches the system ssh client. Navigation diff --git a/docs/release.md b/docs/release.md index 9096cf5..fec51dc 100644 --- a/docs/release.md +++ b/docs/release.md @@ -96,7 +96,7 @@ Upload these files to the release: Release notes should mention platform status: -- Linux is the primary target. +- Linux and macOS are primary release targets. - macOS builds are available as tar.gz for amd64 and arm64 and require the system `ssh` client. - Windows build is experimental and requires OpenSSH Client available as diff --git a/internal/tui/help_screen.go b/internal/tui/help_screen.go index 834c176..ae082dc 100644 --- a/internal/tui/help_screen.go +++ b/internal/tui/help_screen.go @@ -160,7 +160,7 @@ func (m *fullHelpModel) View() string { }{ {"What is sshkeeper", [][2]string{ {"", "sshkeeper is a console SSH connection manager."}, - {"", "Linux is the primary target; macOS builds are available and Windows is experimental."}, + {"", "Linux and macOS are primary release targets; Windows is experimental."}, {"", "It stores server profiles, secrets, and launches the system ssh client."}, {"", ""}, }},