mirror of
https://github.com/Gu1llaum-3/sshm.git
synced 2025-10-19 09:27:19 +02:00
docs: update README.md and remove CONFIG.md
This commit is contained in:
parent
5986659048
commit
049998c235
66
CONFIG.md
66
CONFIG.md
@ -1,66 +0,0 @@
|
|||||||
# SSHM Configuration
|
|
||||||
|
|
||||||
SSHM supports configurable key bindings through a configuration file located at:
|
|
||||||
- Linux/macOS: `~/.config/sshm/config.json`
|
|
||||||
- Windows: `%APPDATA%\sshm\config.json`
|
|
||||||
|
|
||||||
## Configuration Options
|
|
||||||
|
|
||||||
### Key Bindings
|
|
||||||
|
|
||||||
The key bindings section allows you to customize how you exit the application.
|
|
||||||
|
|
||||||
#### Example Configuration
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"key_bindings": {
|
|
||||||
"quit_keys": ["q", "ctrl+c"],
|
|
||||||
"disable_esc_quit": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Options
|
|
||||||
|
|
||||||
- **quit_keys**: Array of keys that will quit the application. Default: `["q", "ctrl+c"]`
|
|
||||||
- **disable_esc_quit**: Boolean flag to disable ESC key from quitting the application. Default: `false`
|
|
||||||
|
|
||||||
## For Vim Users
|
|
||||||
|
|
||||||
If you're a vim user and frequently press ESC accidentally causing the application to quit, set `disable_esc_quit` to `true`:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"key_bindings": {
|
|
||||||
"quit_keys": ["q", "ctrl+c"],
|
|
||||||
"disable_esc_quit": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
With this configuration:
|
|
||||||
- ESC will no longer quit the application
|
|
||||||
- You can still quit using 'q' or Ctrl+C
|
|
||||||
- All other functionality remains the same
|
|
||||||
|
|
||||||
## Default Configuration
|
|
||||||
|
|
||||||
If no configuration file exists, SSHM will create one with these defaults:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"key_bindings": {
|
|
||||||
"quit_keys": ["q", "ctrl+c"],
|
|
||||||
"disable_esc_quit": false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
This ensures backward compatibility - ESC will continue to work as a quit key by default.
|
|
||||||
|
|
||||||
## Configuration Location
|
|
||||||
|
|
||||||
The configuration file will be automatically created when you first run SSHM. You can manually edit it to customize the key bindings to your preference.
|
|
||||||
|
|
||||||
If you encounter any issues with the configuration file, you can delete it and SSHM will recreate it with default settings on the next run.
|
|
30
README.md
30
README.md
@ -553,6 +553,34 @@ This will be automatically converted to:
|
|||||||
StrictHostKeyChecking no
|
StrictHostKeyChecking no
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Custom Key Bindings
|
||||||
|
|
||||||
|
SSHM supports customizable key bindings through a configuration file. This is particularly useful for users who want to modify the default quit behavior.
|
||||||
|
|
||||||
|
**Configuration File Location:**
|
||||||
|
- **Linux/macOS**: `~/.config/sshm/config.json`
|
||||||
|
- **Windows**: `%APPDATA%\sshm\config.json`
|
||||||
|
|
||||||
|
**Example Configuration:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"key_bindings": {
|
||||||
|
"quit_keys": ["q", "ctrl+c"],
|
||||||
|
"disable_esc_quit": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Available Options:**
|
||||||
|
- **quit_keys**: Array of keys that will quit the application. Default: `["q", "ctrl+c"]`
|
||||||
|
- **disable_esc_quit**: Boolean flag to disable ESC key from quitting the application. Default: `false`
|
||||||
|
|
||||||
|
**For Vim Users:**
|
||||||
|
If you frequently press ESC accidentally causing the application to quit, set `disable_esc_quit` to `true`. This will disable ESC as a quit key while preserving all other functionality.
|
||||||
|
|
||||||
|
**Default Configuration:**
|
||||||
|
If no configuration file exists, SSHM will automatically create one with default settings that maintain backward compatibility.
|
||||||
|
|
||||||
## 🛠️ Development
|
## 🛠️ Development
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
@ -669,6 +697,8 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
|||||||
- [Charm](https://charm.sh/) for the amazing TUI libraries
|
- [Charm](https://charm.sh/) for the amazing TUI libraries
|
||||||
- [Cobra](https://cobra.dev/) for the excellent CLI framework
|
- [Cobra](https://cobra.dev/) for the excellent CLI framework
|
||||||
- [@yimeng](https://github.com/yimeng) for contributing SSH Include directive support
|
- [@yimeng](https://github.com/yimeng) for contributing SSH Include directive support
|
||||||
|
- [@ldreux](https://github.com/ldreux) for contributing multi-word search functionality
|
||||||
|
- [@qingfengzxr](https://github.com/qingfengzxr) for contributing custom key bindings support
|
||||||
- The Go community for building such fantastic tools
|
- The Go community for building such fantastic tools
|
||||||
|
|
||||||
---
|
---
|
||||||
|
Loading…
x
Reference in New Issue
Block a user