kevin/asdf
1
Fork 0
mirror of https://github.com/asdf-vm/asdf.git synced 2024-11-15 09:38:16 -07:00
Code Issues Packages Projects Releases Wiki Activity
ced617fd64
asdf/docs/core-commands.md

40 lines
3.4 KiB
Markdown
Raw Normal View History

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 09:32:30 -07:00
## Manage Plugins
| Command | Effect |
| ------------------------------------ | ------------------------------------------------------------ |
Update example commands to not use hypen and use subcommand CLI.
2019-11-27 11:24:54 -07:00
| `asdf plugin add <name> [<git-url>]` | Add a plugin from the plugin repo OR, add a Git repo |
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 09:32:30 -07:00
| | ...as a plugin by specifying the name and repo url |
Update example commands to not use hypen and use subcommand CLI.
2019-11-27 11:24:54 -07:00
| `asdf plugin list` | List installed plugins |
| `asdf plugin list --urls` | List installed plugins with repository URLs |
Update core-commands.md
2019-11-27 11:41:14 -07:00
| `asdf plugin list all` | List plugins registered on asdf-plugins repository with URLs |
Update example commands to not use hypen and use subcommand CLI.
2019-11-27 11:24:54 -07:00
| `asdf plugin remove <name>` | Remove plugin and package versions |
| `asdf plugin update <name>` | Update plugin |
| `asdf plugin update --all` | Update all plugins |
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 09:32:30 -07:00
## Manage Packages
Add documentation in core commands for managing latest stable versions
2019-11-22 11:37:53 -07:00
| 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 install <name> latest[:<version>]` | Install the latest stable version of a package, or with optional version, |
| | ...install the latest stable version that begins with the given string |
| `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 latest <name> [<version>]` | Show latest stable version of a package |
| `asdf list <name>` | List installed versions of a package |
Update example commands to not use hypen and use subcommand CLI.
2019-11-27 11:24:54 -07:00
| `asdf list all <name> [<version>]` | List all versions of a package and optionally filter the returned versions |
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 09:32:30 -07:00
## 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 |
Reference in New Issue Copy Permalink