Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.06 KB

README.textile

File metadata and controls

44 lines (27 loc) · 2.06 KB
Raw

Fish nuggets

The fish nuggets project contains various completions and functions for the amazing Fish shell.

Git features

  • Provides completion for git commands (eg. git ch completes for you)
  • Provides completion of branch names for git branch

Rake features

Completion of rake tasks with task description. The first time you type rake we will create a file containing the rake tasks in /tmp giving you tab completion of rake tasks. This supports several Rakefile locations, so you can use it for different projects.

Capistrano features

Like Rake, lets you use tab completion for Capistrano tasks.

Rubygems features

  • edit_gem with tab completion for gem name lets you view the source for installed gems
  • gem_doc with tab completion for gem name lets you view Rdoc for installed gems

Installation
  cd ~/.config/fish
  git init 
  git add .
  git remote add github git://github.com/zmalltalker/fish-nuggets.git
  git pull github master

Go into ~/.config/fish and add this repository, then pull. This will add the scripts in this projects for you to use.

Customization

Since this repository is intended to replace your ~/.config/fish directory, you should keep your local customizations local – since they are probably of little use to other users.

The package provides some files you may customize:

  • ~/.config/fish/(username).fish: Here you can place custom settings for your current user. This file will be loaded when you start fish
  • ~/.config/fish/(machine name).fish: If you use the same repository on several machines, you may place custom settings for each machine in this file. For instance, if you have two machines: foo and bar, foo.fish will be loaded on foo and bar.fish on bar.
  • ~/.config/fish/(platform).fish: This file is version controlled and keeps platform specific functions. Feel free to contribute functions for your favorite OS here

If you contribute custom functions that you wish to share, please verify that these are not loaded on platforms that don’t support them.