Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reitzig/sdkman-for-fish
Adds support for SDKMAN! to fish
https://github.com/reitzig/sdkman-for-fish
code-completion fish fish-shell plugin sdkman
Last synced: 9 days ago
JSON representation
Adds support for SDKMAN! to fish
- Host: GitHub
- URL: https://github.com/reitzig/sdkman-for-fish
- Owner: reitzig
- License: mit
- Created: 2018-07-11T00:06:58.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-30T22:57:21.000Z (5 months ago)
- Last Synced: 2024-08-01T13:20:32.310Z (3 months ago)
- Topics: code-completion, fish, fish-shell, plugin, sdkman
- Language: Gherkin
- Homepage:
- Size: 104 KB
- Stars: 286
- Watchers: 4
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SDKMAN! for fish
[](https://github.com/reitzig/sdkman-for-fish/blob/main/LICENSE)
[](https://github.com/reitzig/sdkman-for-fish/releases/latest)
[](https://github.com/reitzig/sdkman-for-fish/releases)
[](https://github.com/reitzig/sdkman-for-fish/actions?query=workflow%3ATests+branch%3Amain+event%3Apush++)
[](https://github.com/reitzig/sdkman-for-fish/actions/workflows/codeql.yml)
Makes command `sdk` from [SDKMAN!] usable from [fish], including auto-completion.
Also adds binaries from installed SDKs to the PATH.
Version 2.1.0 has been tested with
- fish 3.7 and
- SDKMAN! 5.18.2 on
- Ubuntu 22.04 LTS and macOS 14.4
## Install
With [fisher] (install separately):
```
fisher install reitzig/[email protected]
```
_Note:_
- Only compatible with fisher v4 upwards; v3 is no longer supported.
- You have to install [SDKMAN!] separately.
- If you have installed SDKMAN! at a custom location, you need to either
- set environment variable `SDKMAN_DIR` to that path using your preferred method, or
- add
```fish
set -g __sdkman_custom_dir /your/path/to/sdkman
```
to a fish config file
[run _before_](https://fishshell.com/docs/current/language.html#configuration-files)
`.config/fish/conf.d/sdk.fish`;
for example, you can use `.config/fish/conf.d/config_sdk.fish`.
- If _both_ are set, `__sdkman_custom_dir` is used.
## Usage
It's all in the background; you should be able to run `sdk` and
binaries installed with `sdk` as you would expect.
## Contribute
When you propose changes,
please run the tests at least on one platform before creating a pull request.
As the tests may mess up your machine
-- you have been warned! --
the recommended way is to run them in a Docker container:
```fish
docker build -t sdkman-for-fish-tests -f test/Dockerfile .
docker run --rm -it sdkman-for-fish-tests
```
A run configuration for Jetbrains IDEs is included.
It is a also possible to run individual features, for instance:
```fish
docker run --rm sdkman-for-fish-tests features/completions.feature
```
## Acknowledgements
* Completion originally by [Ted Wise](https://github.com/ctwise); see his
[blog post from 2016](http://tedwise.com/2016/02/26/using-sdkman-with-the-fish-shell).
* Binary loading originally by [Koala Yeung](https://github.com/yookoala);
see [his comment on sdkman/sdkman-cli#294](https://github.com/sdkman/sdkman-cli/issues/294#issuecomment-318252058).
* While this is predominantly a personal project,
the initial migration to Cucumber tests was done as spike on
[20% time](https://en.wikipedia.org/wiki/20%25_Project)
graciously provided by
[codecentric](https://codecentric.de).
Thank you!
[SDKMAN!]: https://github.com/sdkman/sdkman-cli
[fish]: https://fishshell.com/
[fisher]: https://github.com/jorgebucaran/fisher