Commit Graph

176 Commits (785fa4787006b7509f8f351e441ebb4171433fa6)

Author SHA1 Message Date
Jorge Bucaran 41d5fe0ca6
doc: use git.io/fisher as installation URL since it was restored 6 years ago
Jorge Bucaran 61f6f8c8c4
doc: use raw installation url until https://git.io/fisher is restored 6 years ago
Jorge Bucaran ac3e05ae3e
doc: add upgrading instructions and link to migration guide; #450 6 years ago
Jorge Bucaran 318a1941dc
docs: add link to key bindings info until fish-custom-key-bindings has been published 6 years ago
Jorge Bucaran 54170ef1c3
breaking: implement fisher V3 (#445)
SUMMARY

This  PR  rewrites  fisher  from  the ground  up  and  adds  new
documentation. It introduces some  breaking changes as described
in the  next section. For  a historical background of  this work
see the original V3 proposal #307 and the more recent discussion
about the future of the project #443.

After much debate  and careful consideration I decided  it is in
the best interest of the  project to keep the CLI-based approach
to  dependency  management as  a  facade  to the  fishfile-based
approach originally proposed.

The new `add` commands (previously  `install`) and good ol' `rm`
interactively update  your fishfile and commit  all your changes
in one  sweep. To the  end user, it's as  if you were  adding or
removing  packages like  you already  do now.  Internally, these
commands affect how the fishfile  is parsed and result in adding
new or replacing/removing existing entries followed by a regular
`fisher` run.

INSTALLING

- `install` has been renamed to `add`

- Installing from a gist is  no longer supported (but it will be
back in a future release—removed only to simplify the rewrite)

- To  install a package  from a tag or  branch use an  at symbol
`@`—the colon `:` is deprecated

LISTING

- `ls` and `rm` are still available with a few minor differences

- `ls` followed by a package name does not list specific package
information (may be added back in a future release)

- `ls`  output format  no longer displays  a legend  to indicate
whether a package is a theme or a local package; now it's a flat
dump of every installed package specifier

- For local packages the full path is shown instead

- I want  to add a `--tree`  option in to display  packages in a
tree-like format in the future

- `ls-remote` has been removed as there is no longer a preferred
organization to  look for packages— there  is no plan to  add it
back

UPDATING

-  A new  `self-update` command  has been  introduced to  update
fisher itself

- fisher  will be only  updated when  a new version  is actually
available

- `update` has been removed

-  Everything is  installed from  scratch everytime  you add  or
remove  something,  so  there  is no  need  to  update  specific
packages—you're always up-to-date

-  To  lock  on  a  specific  package  version  install  from  a
tag/branch, e.g., `mypkg/foobar@1.3.2`

UNINSTALLING

- `self-uninstall` works as usual

HELP & VERSION

- `help` only displays fisher usage help

- help is dumped to stdout instead of creating a man page on the
fly and piping it to your pager `version` works as usual

ENVIRONMENT

- `$fish_path` been  renamed to `$fisher_path` to  make it clear
that this is a fisher specific extension, not your shell's

ECOSYSTEM

-  Oh  My  Fish!  packages  are  still  supported,  albeit  less
attention is paid to them

-  Some  packages that  use  Oh  My Fish!  specific  environment
variables or events might not work

- Most of  Oh My Fish! extensions are no  longer necessary since
fish 2.3, therefore it should be a simple matter to upgrade them
to modern fish

DEPENDENCIES

- fisher can now run on fish 2.0

- It's a  good idea to upgrade  to at least fish 2.3  to use the
string builtin and configuration snippets, but there's no reason
for fisher to force you to use any fish version

- `curl` is required for fetching packages

- I am considering adding a  fallback to `wget` if `curl` is not
available on your system

- `git` is optional

-  V3   fetches  packages  directly  from   github,  gitlab  and
bitbucket, if you are using them

- git  is only used  (implementation still  wip) if you  want to
install a  package from an  unknown git  host like your  own git
server
6 years ago
Jorge Bucaran d265de6ef6
refactor: remove slack button 6 years ago
Jorge Bucaran 0a9d7faa8b
docs: add heading 6 years ago
Jorge Bucaran dadcc6c190
docs: add bootstrap note; fix #420 6 years ago
Jorge Bucaran f96c314497
style: remove fisherman logo from README; too large and obnoxious 6 years ago
Dror Levin 8c2c9e1a92 Fix config.fish example for custom paths (#433)
The `fish_function_path` must be set before sourcing the `conf.d` files because they might call functions in that path.
6 years ago
Patrick 196850e09a Add fisherman logo to readme (#436) 6 years ago
Georgy Yakovlev d3b3f6a8e4 2> /dev/null in README 6 years ago
Ryan Sullivan 766bd093a1 Allow for copy instead of linking (#401)
* Allow for optional copy on install instead of linking

* Remove eval in favor of proper test call

* Document fisher_copy variable

* Missing ?
6 years ago
Peeyush Kushwaha 63c59119a6 Add info about generating github token in README
Closes #414
6 years ago
Joe Green 79fc2e6f6b `fisher up` obeys $fish_path (#407)
* Ensure fisherman's completions are placed in the correct fisherman directory when running self update.

* Update documentation to include the extra steps required when setting fish_path.

* -U instead of -g in README.
7 years ago
Jorge Bucaran 9617f27ee3
Add https to URL. 7 years ago
Jorge Bucaran 0f003c0ce1
Add info to the README about how to contribute to the project. 7 years ago
Jorge Bucaran 98ad0d10c4
Update README.md 7 years ago
Jorge Bucaran ba3dd33269
Emphasize fishfile. 7 years ago
Francisco Lourenco e15ccc8f75 Document how to install branches and tags
Closes: #364
7 years ago
Jorge Bucaran f359fa1c51
Fisherman is concurrent (fetch/update), let's make this more prominent. 7 years ago
Jorge Bucaran 92716f334b
Use https. 8 years ago
Jorge Bucaran 742c2cad3f
Update home page URL. 8 years ago
Jorge Bucaran 32d569b5c9
Move badges. 8 years ago
Jorge Bucaran 42c2aa993d
Make fake path more realistic. 8 years ago
Jorge Bucaran 7f8cd6afa9
Make command examples consistent. 8 years ago
Jorge Bucaran 328d742f30
Improve instructions. 8 years ago
Mert ec6c2c4720 Add Turkish translation (#355) 8 years ago
Lorenzo Manacorda 8e57d3744d Explain `ls-remote --format` option
Add example of using `ls-remote --format` to display additional info about available plugins.
8 years ago
Édouard Lopez 008926efc3 add French translation 8 years ago
Jorge Bucaran fe9d45df8b
Update README.md 8 years ago
David Liu 551cdc98f8 Add traditional chinese to wiki 8 years ago
Jorge Bucaran 539dd5bd6a
Update README.md 8 years ago
Jorge Bucaran 49377ba3d7
Update FAQ. 8 years ago
Jorge Bucaran 7c624c1369
Simplify. 8 years ago
Ian Ferguson abddf33f46 Add FAQ for resolving github api token issues 8 years ago
Jorge Bucaran d57bee59ce
Provide more useful instructions that won't leave newbies scratching their head. 8 years ago
Jorge Bucaran 57c859424f
Fix instructions to point to new git.io link. 8 years ago
Jorge Bucaran cde155debd
Introduce fish_path. Fix #301. 8 years ago
Jorge Bucaran 2cb3b58538
Update install instructions. 8 years ago
Jorge Bucaran 655785fac6
Remove brew tap install instructions. 8 years ago
Sajjad Hashemian 4d6b8a1485 Add Persian translation 🇮🇷 (#299) 8 years ago
Jorge Bucaran f129b655d5
Fix typo in install url. 8 years ago
Jorge Bucaran 3f79861722
Better uninstall support, help completions, etc.
* #293, #294
8 years ago
Jorge Bucaran 0fbdd1f15f
Less words, edits. 8 years ago
jona bba611d39a Add German translation 🇩🇪 (#295) 8 years ago
Jorge Bucaran a11c1a9a95
Add brew install instructions. 8 years ago
Jorge Bucaran d3dbe2624d
Remove docs directory.
* Move translations to the wiki to encourage anyone to contribute
  without going through a full PR.
8 years ago
Jorge Bucaran 7259a3ee6a
Introduce $fisher_cmd_name variable to customize fisher command name. 8 years ago
Jorge Bucaran 88b401efa6
Update real rename to sol. 8 years ago