mirror of
https://github.com/asdf-vm/asdf.git
synced 2024-11-15 01:28:17 -07:00
chore: remove -vm from common usage as the tool is just asdf (#798)
This commit is contained in:
James Hegedus
GitHub
parent
0edb50547c
commit
11b5403abb
13
README.md
13
README.md
@ -1,10 +1,10 @@
|
||||
# asdf-vm [](https://github.com/asdf-vm/asdf/actions)
|
||||
# asdf [](https://github.com/asdf-vm/asdf/actions)
|
||||
|
||||
**Manage multiple runtime versions with a single CLI tool, extendable via plugins** - [docs at asdf-vm.com](https://asdf-vm.github.io/asdf/)
|
||||
|
||||
asdf-vm is a CLI tool that can manage multiple language runtime versions on a per-project basis. It is like `gvm`, `nvm`, `rbenv` & `pyenv` (and more) all in one! Simply install your language's plugin!
|
||||
asdf is a CLI tool that can manage multiple language runtime versions on a per-project basis. It is like `gvm`, `nvm`, `rbenv` & `pyenv` (and more) all in one! Simply install your language's plugin!
|
||||
|
||||
## Why use asdf-vm?
|
||||
## Why use asdf?
|
||||
|
||||
- single CLI for multiple languages
|
||||
- consistent commands to manage all your languages
|
||||
@ -19,7 +19,7 @@ asdf-vm is a CLI tool that can manage multiple language runtime versions on a pe
|
||||
|
||||
[Please head over the documentation site for more information](https://asdf-vm.github.io/asdf/)!
|
||||
|
||||
- [Getting Started](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm)
|
||||
- [Getting Started](https://asdf-vm.github.io/asdf/#/core-manage-asdf)
|
||||
- [All Commands](https://asdf-vm.github.io/asdf/#/core-commands)
|
||||
- [All Plugins](https://asdf-vm.github.io/asdf/#/plugins-all)
|
||||
- [Create a Plugin](https://asdf-vm.github.io/asdf/#/plugins-create) with our [asdf-plugin-template](https://github.com/asdf-vm/asdf-plugin-template)
|
||||
@ -32,5 +32,6 @@ See [CONTRIBUTING.md in the repo](https://github.com/asdf-vm/asdf/blob/master/CO
|
||||
## Community & Questions
|
||||
|
||||
<!-- - [Github Discussions TBA](https://github.com/asdf-vm/asdf/discussions): our preferred method for community Q&A and interaction -->
|
||||
- [Github Issues](https://github.com/asdf-vm/asdf/issues): report a bug or raise a feature request to the `asdf` core team
|
||||
- [StackOverflow Tag](https://stackoverflow.com/questions/tagged/asdf-vm): see existing Q&A for `asdf`. Some of the core team watch this tag in addition to our helpful community
|
||||
|
||||
- [ Github Issues](https://github.com/asdf-vm/asdf/issues): report a bug or raise a feature request to the `asdf` core team
|
||||
- [ StackOverflow Tag](https://stackoverflow.com/questions/tagged/asdf-vm): see existing Q&A for `asdf`. Some of the core team watch this tag in addition to our helpful community
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!-- asdf-vm homepage -->
|
||||
<!-- asdf homepage -->
|
||||
|
||||
<!-- include the repo readme -->
|
||||
[](https://raw.githubusercontent.com/asdf-vm/asdf/master/README.md ':include')
|
||||
|
||||
<!-- include the ballad of asdf-vm -->
|
||||
<!-- include the ballad of asdf -->
|
||||
[](https://raw.githubusercontent.com/asdf-vm/asdf/master/ballad-of-asdf.md ':include')
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
<!--  -->
|
||||
<!--  -->
|
||||
|
||||
# asdf-vm
|
||||
# asdf
|
||||
|
||||
> Manage multiple runtime versions with a single CLI tool
|
||||
|
||||
@ -11,4 +11,4 @@
|
||||
- Extend with a simple plugin system
|
||||
|
||||
[GitHub](https://github.com/asdf-vm/asdf)
|
||||
[Get Started](core-manage-asdf-vm)
|
||||
[Get Started](core-manage-asdf)
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<!-- docs/_sidebar.md -->
|
||||
|
||||
- **Core**
|
||||
- [Manage asdf-vm](core-manage-asdf-vm)
|
||||
- [Manage asdf](core-manage-asdf)
|
||||
- [Manage Plugins](core-manage-plugins)
|
||||
- [Manage Versions](core-manage-versions)
|
||||
- [Configuration](core-configuration)
|
||||
@ -11,7 +11,7 @@
|
||||
- [Creating Plugins](plugins-create)
|
||||
- [All Plugins](plugins-all) <!-- pulls in asdf-vm/asdf-plugins readme -->
|
||||
- **Contributing**
|
||||
- [Core asdf vm](contributing-core-asdf-vm)
|
||||
- [Core asdf](contributing-core-asdf)
|
||||
- [Documentation Site](contributing-doc-site)
|
||||
- [Thanks](thanks)
|
||||
- **Community & Questions**
|
||||
|
||||
@ -9,7 +9,7 @@ Here is a list of improvements we are looking at making to the documentation. If
|
||||
- change the typography
|
||||
- get a logo?
|
||||
- improve "edit on GitHub" button/link
|
||||
- add asdf-vm to awesome-docsify showcase
|
||||
- add asdf to awesome-docsify showcase
|
||||
|
||||
## Setup Your Environment
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
1. [Manage asdf-vm](/core-manage-asdf-vm): install `asdf` **and** add `asdf` to your shell
|
||||
1. [Manage asdf](/core-manage-asdf): install `asdf` **and** add `asdf` to your shell
|
||||
2. [Manage Plugins](/core-manage-plugins): add a plugin for your tool `asdf plugin add nodejs`
|
||||
3. [Manage Versions](/core-manage-versions): install a version of that tool `asdf install nodejs 13.14.0`
|
||||
4. [Configuration](/core-configuration): set global and project tool versions via `.tool-versions` config
|
||||
@ -1,6 +1,6 @@
|
||||
Plugins are how asdf-vm understands handling different packages.
|
||||
Plugins are how asdf understands handling different packages.
|
||||
|
||||
See [All plugins](plugins-all) for the plugins repository which lists all asdf-vm plugins we know.
|
||||
See [All plugins](plugins-all) for the plugins repository which lists all asdf plugins we know.
|
||||
|
||||
See [Creating Plugins](plugins-create) for the super-simple API for supporting more languages.
|
||||
|
||||
|
||||
@ -106,13 +106,13 @@ asdf uninstall <name> <version>
|
||||
|
||||
## Shims
|
||||
|
||||
When asdf-vm installs a package it creates shims for every executable program in that package in a `$ASDF_DATA_DIR/shims` directory (default `~/.asdf/shims`). This directory being on the `$PATH` (by means of `asdf.sh` or `asdf.fish`) is how the installed programs are made available in the environment.
|
||||
When asdf installs a package it creates shims for every executable program in that package in a `$ASDF_DATA_DIR/shims` directory (default `~/.asdf/shims`). This directory being on the `$PATH` (by means of `asdf.sh` or `asdf.fish`) is how the installed programs are made available in the environment.
|
||||
|
||||
The shims themselves are really simple wrappers that `exec` a helper program `asdf exec` passing it the name of the plugin and path to the executable in the installed package that the shim is wrapping.
|
||||
|
||||
The `asdf exec` helper determines the version of the package to use (as specified in `.tool-versions` file, selected by `asdf local ...` or `asdf global ...`), the final path to the executable in the package installation directory (this can be manipulated by the `exec-path` callback in the plugin) and the environment to execute in (also provided by the plugin - `exec-env` script), and finally it executes it.
|
||||
|
||||
!> Note that because this system uses `exec` calls, any scripts in the package that are meant to be sourced by the shell instead of executed need to be accessed directly instead of via the shim wrapper. The two asdf-vm commands: `which` and `where` can help with this by returning the path to the installed package:
|
||||
!> Note that because this system uses `exec` calls, any scripts in the package that are meant to be sourced by the shell instead of executed need to be accessed directly instead of via the shim wrapper. The two asdf commands: `which` and `where` can help with this by returning the path to the installed package:
|
||||
|
||||
```shell
|
||||
# returns path to main executable in current version
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8" />
|
||||
<title>asdf vm - An extendable version manager</title>
|
||||
<title>asdf - An extendable version manager</title>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
|
||||
<meta name="description" content="An extendable version manager" />
|
||||
<meta
|
||||
@ -27,7 +27,7 @@
|
||||
<script src="scripts/docsify-edit-on-github.js"></script>
|
||||
<script>
|
||||
window.$docsify = {
|
||||
name: "asdf-vm",
|
||||
name: "asdf",
|
||||
repo: "https://github.com/asdf-vm/asdf",
|
||||
el: "#app",
|
||||
coverpage: true,
|
||||
|
||||
Loading…
Reference in New Issue
Block a user