An open API service indexing awesome lists of open source software.

https://github.com/jsforce/jsforce-zsh-completions

zsh completion functions for jsforce CLI & metadata tools
https://github.com/jsforce/jsforce-zsh-completions

Last synced: 5 months ago
JSON representation

zsh completion functions for jsforce CLI & metadata tools

Awesome Lists containing this project

README

          

# JSforce Zsh Completion functions

Completion functions in [Zsh](http://www.zsh.org) for [JSforce](https://jsforce.github.io) CLI and its [metadata tools](https://github.com/jsforce/jsforce-metadata-tools).

## Installation

* Clone the repository:

git clone git://github.com/jsforce/jsforce-zsh-completions.git

* Include the directory in your `$fpath`, for example by adding in `~/.zshrc`:

fpath=(path/to/jsforce-zsh-completions/functions $fpath)

* You may have to force rebuild `zcompdump`:

rm -f ~/.zcompdump; compinit

## Feature

- Complete all options available in CLI
- For `--c, --connection` option argument, complete candidates from registered connections established in former OAuth2 authorization flow, reading JSforce config file (`~/.jsforce/config.json`).

```
$ jsforce --connection admin@a
-- connections --
admin@aaa.example.com admin@abb.example.org
admin@abc.example.net admin@abcd.example.org
```

## Requirement

Addition to the installation process above, you need to install [jq](https://stedolan.github.io/jq/) to get connection completion feature to work.