Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/y3owk1n/fish-x
Extra common utilities for Fish 🐟
https://github.com/y3owk1n/fish-x
cli commandline fish fish-packages fish-plugin fish-shell fisher
Last synced: 4 months ago
JSON representation
Extra common utilities for Fish 🐟
- Host: GitHub
- URL: https://github.com/y3owk1n/fish-x
- Owner: y3owk1n
- License: mit
- Created: 2024-01-05T16:56:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-29T15:19:54.000Z (6 months ago)
- Last Synced: 2024-07-29T20:44:58.502Z (6 months ago)
- Topics: cli, commandline, fish, fish-packages, fish-plugin, fish-shell, fisher
- Language: Shell
- Homepage:
- Size: 17.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Extra common utilities for Fish 🐟
Welcome to `fish-x`, a Fish shell plugin that enhances your shell experience with upgraded commands on top of regular commands. Typically normal commands that ends with `x`.
- `mkdirx` - Make a directory and cd into it.
- `touchx` - Touch a new file and open in preferred editor.
- `gclx` - Git clone a repository and cd into it.
> This plugin has no intention to wrap around normal commands. E.g. wrap around `mkdir` to make it auto cd. There might be alot internal use cases for these common commands. Just type an `x` for a slight quality of improvement in life.
## Installation
### Using Nix's Home Manager (Recommended)
```fish
{
programs.fish = {
enable = true;
plugins = [
{
name = "fish-x";
src = pkgs.fetchFromGitHub {
owner = "y3owk1n";
repo = "fish-x";
rev = "v1.2.0";
sha256 = "generated-sha-256-values";
};
}
];
};
}
```
### Using Fisher
```fish
fisher install y3owk1n/fish-x
```
### Manually
1. Clone this repository:
```fish
git clone https://github.com/y3owk1n/fish-x.git
```
2. Source the all the functions/*.fish file in your Fish configuration:
```fish
source /path/to/gclx.fish
source /path/to/mkdirx.fish
source /path/to/touchx.fish
```
## Functions
### 1. `gclx` - Git Clone and Change Directory
The `gclx` function simplifies the process of cloning a Git repository and navigating into it with a single command.
#### Usage
```fish
gclx owner/repo
```
or
```fish
gclx https://github.com/owner/repo.git
```
We support `--bare` flag for worktree users like me.
```fish
gclx --bare owner/repo
```
### 2. `mkdirx` - Create Directory and Change Directory
The `mkdirx` function combines creating a directory and changing into it in a single command, streamlining your workflow.
#### Usage
```fish
mkdirx [folder-name]
```
### 3. `touchx` - Touch and Open in Editor
The `touchx` function creates or updates a file and opens it in your preferred editor, ensuring a seamless editing experience.
#### Usage
```fish
touchx [file-name]
```
## Configuration
Before using `touchx`, ensure that your preferred editor is set in the **$EDITOR** environment variable. You can set it using:
```fish
set -Ux EDITOR nvim # vim, code, emacs, etc.
```
## Troubleshooting
If you encounter any issues or errors, please refer to the ~~troubleshooting section in the wiki~~ (Not ready yet).
## Contributions
Feel free to contribute by opening issues, suggesting enhancements, or submitting pull requests. We value your feedback and ideas to enhance the capabilities of `fish-x` further!
## License
This plugin is licensed under the MIT License. Feel free to use, modify, and distribute it as you see fit.
Happy fishing! 🐟