mirror of
https://github.com/oh-my-fish/oh-my-fish.git
synced 2025-02-09 10:38:29 +08:00
ebd7192cd1
Address the use case of autoload path removal, which allows themes and packages definitions to be unloaded from running fish session.
87 lines
2.3 KiB
Markdown
87 lines
2.3 KiB
Markdown
<p align="center">
|
|
<a href="https://github.com/oh-my-fish/oh-my-fish/blob/master/README.md">
|
|
<img width="100px" src="https://cloud.githubusercontent.com/assets/8317250/8510172/f006f0a4-230f-11e5-98b6-5c2e3c87088f.png">
|
|
</a>
|
|
</p>
|
|
|
|
# Core Library
|
|
|
|
## Basic Functions
|
|
|
|
#### `autoload` _`[-e] <path>...`_
|
|
|
|
Manipulate [autoloading](http://fishshell.com/docs/current/index.html#syntax-function-autoloading) path components.
|
|
|
|
All paths ending with `completions` are correctly added to or erased from
|
|
`$fish_complete_path`.
|
|
|
|
To add paths to autoload:
|
|
|
|
```fish
|
|
autoload $mypath $mypath/completions
|
|
```
|
|
|
|
To erase paths from autoload:
|
|
|
|
```fish
|
|
autoload -e $mypath $mypath/completions
|
|
```
|
|
|
|
#### `available` _`<name>`_
|
|
|
|
Check if a program is available to run. Sets `$status` to `0` if the program is available.
|
|
|
|
Use this function to check if a plugin is available before using it:
|
|
|
|
```fish
|
|
if available battery
|
|
battery
|
|
end
|
|
```
|
|
|
|
#### `basename` _`<path> ...`_
|
|
|
|
Wrap basename so it can handle multiple arguments.
|
|
|
|
#### `refresh`
|
|
|
|
Replace the running instance of fishshell with a new one causing Oh My Fish to reload as well.
|
|
|
|
#### `prompt_segments`
|
|
|
|
Extract the root (top-most parent directory), dirname and basename from [`fish_prompt`](http://fishshell.com/docs/current/faq.html#faq-prompt).
|
|
|
|
## Git Functions
|
|
#### `git_ahead`
|
|
|
|
Echo a character that represents whether the current repo is ahead, behind or has diverged from its upstream.
|
|
|
|
##### Default values:
|
|
|
|
+ ahead: `+`
|
|
+ behind: `-`
|
|
+ diverged: `±`
|
|
+ none: ` `
|
|
|
|
#### `git_is_repo`
|
|
Set `$status` to `0` if the current working directory belongs to a git repo.
|
|
|
|
#### `git_branch_name`
|
|
Echo the currently checked out branch name of the current repo.
|
|
|
|
#### `git_is_dirty`
|
|
Set `$status` to `0` if there are any changes to files already being tracked in the repo.
|
|
|
|
#### `git_is_staged`
|
|
Set `$status` to `0` if there [staged](http://programmers.stackexchange.com/questions/119782/what-does-stage-mean-in-git) changes.
|
|
|
|
#### `git_is_stashed`
|
|
Set `$status` to `0` if there are items in the [stash](https://git-scm.com/book/en/v1/Git-Tools-Stashing).
|
|
|
|
#### `git_is_touched`
|
|
|
|
Set `$status` to `0` if the repo has any changes whatsoever, including [tracked or untracked](http://stackoverflow.com/questions/9663507/what-is-tracked-files-and-untracked-files-in-the-context-of-git) files.
|
|
|
|
#### `git_untracked`
|
|
Echo a `\n` separated list of untracked files.
|