erik/sdkman-for-fish
erik/sdkman-for-fish
1
0
Fork 0
mirror of https://github.com/ethauvin/sdkman-for-fish.git synced 2025-04-24 04:47:11 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions
Adds support for SDKMAN! to fish
134 commits 1 branch 0 tags 224 KiB
Find a file
Exact
Erik C. Thauvin 790694ac92
fix: Use builtin rm to bypass any potential alias or function
2024-09-13 12:02:10 -07:00
.github fix(ci): Set RUNNING_IN_CONTAINER in workflow 2024-04-04 00:03:23 +02:00
.idea fix: Tests for completions with custom install path 2024-04-03 22:20:29 +02:00
completions fix: Completions use custom install location 2024-04-03 22:20:29 +02:00
conf.d fix: Use builtin rm to bypass any potential alias or function 2024-09-13 12:02:10 -07:00
functions chore: Switch trunk to main 2023-06-27 00:28:22 +02:00
test feat(ci): Prevent test runs outside of container 2024-04-03 23:56:16 +02:00
.editorconfig Final macOS incompatibility fix. 2019-11-06 20:52:07 +01:00
.gitignore fix: Tests for completions with custom install path 2024-04-03 22:20:29 +02:00
CHANGELOG.md chore(docs): Release 2.1.0 2024-04-03 23:58:08 +02:00
LICENSE chore: Switch trunk to main 2023-06-27 00:28:22 +02:00
README.md chore(docs): Release 2.1.0 2024-04-03 23:58:08 +02:00

README.md

SDKMAN! for fish

license release GitHub release date Test CodeQL

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/sdkman-for-fish@v2.1.0

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 
      set -g __sdkman_custom_dir /your/path/to/sdkman
      to a fish config file run before .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:

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:

docker run --rm sdkman-for-fish-tests features/completions.feature

Acknowledgements