mirivlad
/
sshkeeper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

docs: clarify platform and repository status

This commit is contained in:
mirivlad 2026-06-06 11:14:15 +08:00
parent 8e59c3052e
commit 604a4ecde2
5 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,10 +1,10 @@
# sshkeeper # sshkeeper
`sshkeeper` is a console manager for SSH profiles, secrets, and quick OpenSSH `sshkeeper` is a console manager for SSH profiles, secrets, and quick OpenSSH
launches. Primary target: Linux. macOS builds are available, and Windows builds launches. Linux and macOS are the primary release targets; Windows builds are
are experimental. It does not replace OpenSSH; it keeps connection metadata in a experimental. It does not replace OpenSSH; it keeps connection metadata in a local
local SQLite database, keeps passwords/passphrases in an encrypted vault, and SQLite database, keeps passwords/passphrases in an encrypted vault, and starts
starts the system `ssh` client with the right options. the system `ssh` client with the right options.
## sshkeeper is not Ansible ## sshkeeper is not Ansible
@ -34,7 +34,7 @@ port forwarding management.
### Build from source ### Build from source
```bash ```bash
git clone git@git.mirv.top:mirivlad/sshkeeper.git git clone git@github.com:mirivlad/sshkeeper.git
cd sshkeeper cd sshkeeper
go build -o ~/.local/bin/sshkeeper . go build -o ~/.local/bin/sshkeeper .
``` ```
@ -52,8 +52,8 @@ Platform status:
| Platform | Status | Notes | | Platform | Status | Notes |
|----------|--------|-------| |----------|--------|-------|
| Linux | Primary target | `linux/amd64` and `linux/arm64` release tarballs are available. | | Linux | Primary release 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. | | 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. | | 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: 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:** **Source repositories:**
- Main public: [github.com/mirivlad/sshkeeper](https://github.com/mirivlad/sshkeeper) - Primary public repository: [github.com/mirivlad/sshkeeper](https://github.com/mirivlad/sshkeeper)
- Mirror/dev: `git@git.mirv.top:mirivlad/sshkeeper` - Self-hosted mirror: `git@git.mirv.top:mirivlad/sshkeeper`
### Install from release (after v0.2.0 publication) ### Install from release (after v0.2.0 publication)

2
cmd/root.go
View File

@ -22,7 +22,7 @@ var rootCmd = &cobra.Command{
Use: "sshkeeper", Use: "sshkeeper",
Short: "sshkeeper — SSH connection manager", Short: "sshkeeper — SSH connection manager",
Long: `sshkeeper is a console 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 It manages server profiles, secrets, and provides a convenient way
to launch SSH sessions using the system OpenSSH client.`, to launch SSH sessions using the system OpenSSH client.`,
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {

12
docs/guide.md
View File

@ -18,7 +18,7 @@
## Что такое sshkeeper ## Что такое sshkeeper
sshkeeper — это консольный менеджер SSH-подключений. Основная целевая платформа — Linux; сборки для macOS доступны, Windows-сборка пока экспериментальная. Он хранит профили серверов, секреты (пароли, фразы от ключей) и запускает системный `ssh` с нужными опциями. sshkeeper — это консольный менеджер SSH-подключений. Основные релизные платформы — Linux и macOS; Windows-сборка пока экспериментальная. Он хранит профили серверов, секреты (пароли, фразы от ключей) и запускает системный `ssh` с нужными опциями.
**Чем sshkeeper НЕ является:** **Чем sshkeeper НЕ является:**
- Это не Ansible — он не настраивает серверы и не пушит файлы - Это не Ansible — он не настраивает серверы и не пушит файлы
@ -42,7 +42,7 @@ sshkeeper — это консольный менеджер SSH-подключе
**Исходники:** **Исходники:**
- Основной публичный репозиторий: [github.com/mirivlad/sshkeeper](https://github.com/mirivlad/sshkeeper) - Основной публичный репозиторий: [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 ```bash
git clone git@git.mirv.top:mirivlad/sshkeeper.git git clone git@github.com:mirivlad/sshkeeper.git
cd sshkeeper cd sshkeeper
go build -o ~/.local/bin/sshkeeper . go build -o ~/.local/bin/sshkeeper .
``` ```
@ -69,8 +69,8 @@ go build -o ~/.local/bin/sshkeeper .
| Платформа | Статус | Примечание | | Платформа | Статус | Примечание |
|-----------|--------|------------| |-----------|--------|------------|
| Linux | Основная целевая платформа | Архивы `linux/amd64` и `linux/arm64`. | | Linux | Основная релизная платформа | Архивы `linux/amd64` и `linux/arm64`. |
| macOS | Сборки доступны, требуется проверка на целевых машинах | Архивы `darwin/amd64` и `darwin/arm64`, нужен системный `ssh`. Homebrew formula запланирована. | | macOS | Основная релизная платформа | Архивы `darwin/amd64` и `darwin/arm64`, нужен системный `ssh`. Homebrew formula запланирована. |
| Windows | Experimental | Нужен OpenSSH Client как `ssh.exe` в `PATH`; password/key-passphrase PTY-сценарии на Windows пока не подтверждены. | | Windows | Experimental | Нужен OpenSSH Client как `ssh.exe` в `PATH`; password/key-passphrase PTY-сценарии на Windows пока не подтверждены. |
На Windows OpenSSH Client можно установить через Windows Optional Features или PowerShell: На Windows OpenSSH Client можно установить через Windows Optional Features или PowerShell:
@ -206,7 +206,7 @@ sshkeeper — Full Help
What is sshkeeper What is sshkeeper
sshkeeper is a console SSH connection manager. 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. It stores server profiles, secrets, and launches the system ssh client.
Navigation Navigation

2
docs/release.md
View File

@ -96,7 +96,7 @@ Upload these files to the release:
Release notes should mention platform status: 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 - macOS builds are available as tar.gz for amd64 and arm64 and require the
system `ssh` client. system `ssh` client.
- Windows build is experimental and requires OpenSSH Client available as - Windows build is experimental and requires OpenSSH Client available as

2
internal/tui/help_screen.go
View File

@ -160,7 +160,7 @@ func (m *fullHelpModel) View() string {
}{ }{
{"What is sshkeeper", [][2]string{ {"What is sshkeeper", [][2]string{
{"", "sshkeeper is a console SSH connection manager."}, {"", "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."}, {"", "It stores server profiles, secrets, and launches the system ssh client."},
{"", ""}, {"", ""},
}}, }},