asdf/docs/core-commands.md
James Hegedus 2fcde332ae Documentation site (#422)
* init docsify
* add config & plugins to support required features
* create cover page
* add sidebar headings
* add novel 404 page
* add translation message to 404
* add navbar with translations dropdown
* fix punctuation
* add all-plugins section pulling from asdf-plugins repo readme
* update sidebar with sections, better names & descriptions for contributors
* add changelog. pulls from repo
* add thanks page. credits, maintainers & link to contributors on github
* add core documentation
* rm old readme from docs/ folder
this was copied here on docsify init
* comment out some translation config
  ideally this will remain commented out serving as an example for any translation contributions
* run prettier over markdown
* add plugins-create section
* add contributing sections to the docs
* fix cover page get-started link
* use the readme as the main homepage
* update asdf version in docs with release script
2019-01-12 11:32:30 -05:00

37 lines
2.9 KiB
Markdown

## Manage Plugins
| Command | Effect |
| ------------------------------------ | ------------------------------------------------------------ |
| `asdf plugin-add <name> [<git-url>]` | Add a plugin from the plugin repo OR, add a Git repo |
| | ...as a plugin by specifying the name and repo url |
| `asdf plugin-list` | List installed plugins |
| `asdf plugin-list --urls` | List installed plugins with repository URLs |
| `asdf plugin-list-all` | List plugins registered on asdf-plugins repository with URLs |
| `asdf plugin-remove <name>` | Remove plugin and package versions |
| `asdf plugin-update <name>` | Update plugin |
| `asdf plugin-update --all` | Update all plugins |
## Manage Packages
| Command | Effect |
| --------------------------------- | --------------------------------------------------------------------- |
| `asdf install [<name> <version>]` | Install a specific version of a package, or with no arguments, |
| | ...install all the package versions listed in the .tool-versions file |
| `asdf uninstall <name> <version>` | Remove a specific version of a package |
| `asdf current` | Display current version set or being used for all packages |
| `asdf current <name>` | Display current version set or being used for package |
| `asdf where <name> [<version>]` | Display install path for an installed or current version |
| `asdf which <name>` | Display install path for current version |
| `asdf local <name> <version>` | Set the package local version |
| `asdf global <name> <version>` | Set the package global version |
| `asdf list <name>` | List installed versions of a package |
| `asdf list-all <name>` | List all versions of a package |
## Utils
| Command | Effect |
| ------------------------------ | ---------------------------------------------- |
| `asdf reshim <name> <version>` | Recreate shims for version of a package |
| `asdf update` | Update asdf to the latest stable release |
| `asdf update --head` | Update asdf to the latest on the master branch |