README.md

Glass's Custom Fish Environment

Custom fish environment with a (kinda) pretty prompt, and some convenience aliases and functions.

Contents

• setup.fish: Initializes shell environment:

• Symlinks repo to ~/.config/fish

• Checks for SSH key, creates if missing

• Sets Git user name and email (user input) if not already set

• config.fish: Main configuration file. Set some variables, configure paths, source scripts/custom functions/packages, etc.

• functions/: Contains all custom content, including:

  • aliases - custom aliases
  • functions - custom functions
  • fish prompt - custom, colorized, and informational prompt
  • and utility for other useful tools such as bass and nvm

• fish_variables: Auto-generated by Fish. Not recommended to edit directly.

• fish-tips/: Just some useful chunks of fish code

Setup

1. Clone the repo
   ><> git clone https://gitlab.com/glass-ships/glass-fish.git

2. Initialize new environment:
   ><> cd glass-fish ;; fish setup.fish

3. (Optional) Store any secrets as environment variables. Create a file called secrets.json in the root of the repo.

   • This file is ignored by git, so your secrets are safe if you contribute to this repository.
     The format should be:

   {
      "SECRET_ONE": "SECRET_VALUE",
      "SECRET_TWO": "OTHER_SECRET_VALUE"
      ...
   }

4. (Optional) For plugin management, install fisher or Oh My Fish

5. (Optional) For BASH compatibility, add EDC/Bass

6. Enjoy!

Contributing

This repo could probably use some regular TLC. If you're interested in helping out, just create an issue, or fork the repo and merge request back in!

~ Glass