Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 131 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,139 @@
# SSH+
This application allows you to create alias connections
and use them when selecting an ssh connection.
# Misha - cli ssh client

![GitHub top language](https://img.shields.io/github/languages/top/ssh-connection-manager/ssh-)
![GitHub](https://img.shields.io/github/license/ssh-connection-manager/ssh-)
![GitHub Repo stars](https://img.shields.io/github/stars/ssh-connection-manager/ssh-)
![GitHub issues](https://img.shields.io/github/issues/ssh-connection-manager/ssh-)
![Go Report Card](https://goreportcard.com/badge/github.com/misha-ssh/cli)
![Release](https://img.shields.io/github/release/misha-ssh/cli?status.svg)
![Action Lint](https://github.com/misha-ssh/cli/actions/workflows/lint.yml/badge.svg)
![Action Build](https://github.com/misha-ssh/cli/actions/workflows/build.yml/badge.svg)
![GitHub Repo stars](https://img.shields.io/github/stars/misha-ssh/cli)

## Documentation
User [documentation](https://misha-ssh.github.io/docs/) is available at.
Misha - SSH client made on go

## Installation
Made using data from packages:

How to install the utility is told here at the [link](https://ssh-connection-manager.github.io/docs/documentation/download.html).
* [cobra](https://github.com/spf13/cobra)
* [fang](http://github.com/charmbracelet/fang)
* [huh](https://github.com/charmbracelet/huh)

## Contributing
## ✨ Documentation

Please see [CONTRIBUTING](https://github.com/ssh-connection-manager/ssh-/blob/main/CONTRIBUTING.md) for details.
You can read the documentation by clicking on the [link](https://misha-ssh.github.io/docs)

## License
Licensed under the MIT [license](https://github.com/ssh-connection-manager/ssh-?tab=MIT-1-ov-file).
## ✨ Install

Install using homebrew:

```bash
# macOS or Linux
brew install --cask misha
```
You can also install the package from the release via the [link](https://github.com/misha-ssh/cli/releases)

## 📖 Examples & Usage

The list of commands that you can use in this SSH client

### 🔌 Connect

The command to connect to the remote server

[![asciicast](https://asciinema.org/a/734047.svg)](https://asciinema.org/a/734047)

### ✍️ Create

The command to create a connection

[![asciicast](https://asciinema.org/a/734049.svg)](https://asciinema.org/a/734049)

### 🪄 Update

The command to update the connection

[![asciicast](https://asciinema.org/a/734050.svg)](https://asciinema.org/a/734050)

### 🆑 Delete

The command to delete the connection

[![asciicast](https://asciinema.org/a/734051.svg)](https://asciinema.org/a/734051)

### 🤖 Run ssh server

for local testing, you can raise your ssh servers - there are three types of them.

1) password connection

to run, write the command:

```bash
make up-ssh
```

to install and remove the server:

```bash
make down-ssh
```

Server accesses:

* ``login`` - root
* ``address`` - localhost
* ``password`` - password
* ``port`` - 22

2) connect with a private key

to run, write the command:

```bash
make up-ssh-key
```

to install and remove the server:

```bash
make down-ssh-key
```

Server accesses:

* ``login`` - root
* ``address`` - localhost
* ``private key`` - ./dockerkey
* ``port`` - 2222

3) connecting via a non-standard port

to run, write the command:

```bash
make up-ssh-port
```

to install and remove the server:

```bash
make down-ssh-port
```

Server accesses:

* ``login`` - root
* ``address`` - localhost
* ``password`` - password
* ``port`` - 2222


## 🧪 Testing

The command to launch the linter:

```bash
make lint
```

## 🤝 Feedback

We appreciate your support and look forward to making our product even better with your help!

[@Denis Korbakov](https://github.com/deniskorbakov)
Loading