softinio/Fishee
1
0
Fork 0
mirror of https://github.com/softinio/Fishee.git synced 2025-02-22 13:36:04 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Update README.md with detailed overview of Fishee tool features

Browse source
This commit is contained in:
Salar Rahmanian 2025-02-01 23:14:25 -08:00
parent b1534b4ad2
commit d2b3d2be3c
1 changed files with 17 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -4,47 +4,43 @@
# Fishee
Fishee CLI Tool for Fish Shell
Fishee is a command-line interface (CLI) tool designed specifically for users of the Fish Shell. It provides a convenient way to manage and manipulate your Fish Shell history files, making it easier to maintain and transfer command history across different environments.
## About Fishee
So I have been a user of Fish Shell for quite a while now and really enjoy using it.
So I decided to write this CLI tool for Fish Shell that helps me manage my fish history.
As a long-time user of the Fish Shell, I developed Fishee to streamline the process of handling Fish Shell history files. Whether you're looking to consolidate history from multiple machines or simply want to clean up your existing history, Fishee offers a set of features to assist you.
## Features
- Print my fish history
- Merge two history files into one
- Useful for when you want to add fish history from one computer to another
- remove duplicates from history file when merging
- **Print Fish History**: Display the contents of your Fish Shell history file directly in the terminal.
- **Merge History Files**: Combine two Fish Shell history files into one. This is particularly useful when you want to integrate history from different computers or backups.
- **Remove Duplicates**: Automatically eliminate duplicate entries from the merged history file, ensuring a clean and concise history.
- **Backup and Restore**: Optionally create a backup of your current history file before making any changes, providing a safety net in case you need to revert.
## Usage
In terminal run:
To get started with Fishee, open your terminal and run the following command to see the available options:
```bash
fishee --help
```
### Command-Line Options
```
USAGE: fishee [--history-file <history-file>] [--merge-file <merge-file>] [--output-file <output-file>] [--dry-run] [--remove-duplicates] [--backup] [--no-backup]
OPTIONS:
-f, --history-file <history-file>
Location of your fish history file. Will default to
~/.local/share/fish/fish_history
Specify the location of your Fish Shell history file. Defaults to
~/.local/share/fish/fish_history if not provided.
-m, --merge-file <merge-file>
File path to file to merge with history file.
Provide the file path of the history file you wish to merge with your current history.
-w, --output-file <output-file>
File to write to. Default: same as current history
file.
-d, --dry-run Dry run. Will only print to the console without
actually modifying the history file.
-r, --remove-duplicates Remove duplicates from combined history. Default:
false
Define the file to write the merged history to. By default, it overwrites the current history file.
-d, --dry-run Perform a dry run to preview changes without modifying the actual history file.
-r, --remove-duplicates Remove duplicate entries from the combined history. Default is false.
-b, --backup/--no-backup
Backup fish history file given before writing.
(default: --backup)
-h, --help
Choose whether to backup the current history file before writing changes. Default is --backup.
-h, --help Display help information about the Fishee tool.
```