Skip to content

mschmidtkorth/fish-prompt-salesforce-dx

Repository files navigation

Salesforce DX (SFDX) Status for fish

Adds the status of Salesforce DX projects to your fish prompt. Compatible with other prompts, e.g. Pure.

Requirements

Installation

  • Copy _prompt_sfdx.fish to ~/.config/fish/functions/
  • If you are using Pure prompt: Copy fish_prompt.fish_pure to ~/.config/fish/functions/ and rename to fish_prompt.fish (replace existing file, backup before)
  • If you are using bobthefish prompt: Copy fish_prompt.fish_bobthefish to ~/.config/fish/functions/ and rename to fish_prompt.fish (replace existing file, backup before)
  • If you are using any other prompt or the default fish prompt: Put echo -e -n (_prompt_sfdx) wherever you would like to see the output in ~/.config/fish/functions/fish_prompt.fish
  • If you are using Nerd Fonts, set set -g nerdFonts no to set -g nerdFonts yes in _prompt_sfdx.fish (recommended e.g. for bobthefish)

Note You may also modify fish_prompt.fish instead of replacing it.

Usage

  • Simply open any directory that contains a .force folder and watch your prompt change

Pure prompt: Example with Pure prompt

bobthefish prompt: Example with bobthefish prompt

Note The iTerm2 status bar component at the bottom can be found here.

How to Contribute

Please see the contribution guidelines.

Changelog

  • 0.1.0 (2020-02-19)
    • Initial release