Commit 2fcde33

<h2 align="center">404</h2>

<p align="center">

Woops! It seems we're lost! :sweat_smile:

<br />

Let's <a href="/">go home</a> and try again.

<br />

If we end up lost again, <a href="https://github.com/asdf-vm/asdf/issues/new">yell out for some help</a> :mega:

</p>

<p align="center">

If you are here because of a missing section or translation, please <a href="/#/contributing">think of contributing</a> :two_hearts:

</p>

- Bash, Zsh, Fish

- Node.js, Ruby, Python, Elixir ... and more

- Simple plugin system

[GitHub](https://github.com/asdf-vm/asdf)

[Get Started](core-manage-asdf-vm)

- Translations

- [:uk: English](/)

- [Home](/) <!-- ballad of asdf here -->

- Core

- [Manage asdf-vm](core-manage-asdf-vm)

- [Manage Plugins](core-manage-plugins)

- [Manage Versions](core-manage-versions)

- [Configuration](core-configuration) <!-- tool-versions & .asdfrc & env vars-->

- [All Commands](core-commands) <!-- include uninstall instructions -->

- Plugins

- [Creating Plugins](plugins-create)

- [All Plugins](plugins-all) <!-- pulls in asdf-vm/asdf-plugins readme -->

- Contributing

- [Core asdf vm](contributing-core-asdf-vm)

- [Documentation Site](contributing-doc-site)

- [Changelog](changelog) <!-- pulls in changelog from repo -->

- [Thanks](thanks) <!-- credits, maintainers, contributors -->

To develop the project, simply `git clone` the master branch.

If you want to try out your changes without making change to your installed `asdf`, you can set the `$ASDF_DIR` variable to the path where you cloned the repository, and temporarily prepend the `bin` and `shims` directory of the directory to your path.

Tools we use:

- [bats](https://github.com/sstephenson/bats) for testing. Make sure

`bats test/` passes after you made your changes.

- [Shellcheck](https://github.com/koalaman/shellcheck) for static analysis of our shell scripts.

The [asdf-alpine][asdf-alpine] and [asdf-ubuntu][asdf-ubuntu] projects are an

ongoing effort to provide Dockerized images of some asdf tools. You can use

these docker images as base for your development servers, or for running your

production apps.

[asdf-alpine]: https://github.com/vic/asdf-alpine

[asdf-ubuntu]: https://github.com/vic/asdf-ubuntu

We're using:

- [Node.js](https://github.com/asdf-vm/asdf-nodejs) `v10.15.0` to support the other required tools

- [docsify](https://docsify.js.org/#/) to create our documentation site

- [prettier](https://prettier.io/) to format our markdown files

We are trying to **avoid polluting** the core repo with tooling for this documentation site. As such, it would be great if you could install these development tools **globally** so we don't need to commit them to this project.

npm i docsify-cli prettier -g

From the root of this repo run:

docsify serve docs

From the root of this repo run:

prettier --write "docs/**/*.md"

It would be great to provide translations for other languages.

Docsify makes adding new languages quite easy. Look in `docs/index.html` for commented out `zh-cn` examples.

1. create a folder in `docs/` for the new translation

```

```

2. copy file from root `docs/_404.md` to new folder `docs/zh-cn/_404.md`

```

```

3. replace text with translated text.

4. repeat for all files.

5. add a link to the new translation in `_navbar.md`.

6. run `prettier` before committing.

For more information, see the [Configuration](https://docsify.js.org/#/configuration) docsify docs, the [Custom navbar](https://docsify.js.org/#/custom-navbar) docsify docs, and have a look at their own `index.html`'s [search section](https://github.com/docsifyjs/docsify/blob/6ac7bace213145cb655e9a5e9e209384db08e5f9/docs/index.html#L48).

| 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 |

| 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 |

| 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 |

Whenever `.tool-versions` file is present in a directory, the tool versions it declares will be used in that directory and any subdirectories. **Global defaults can be set in the file `$HOME/.tool-versions`**

This is what a `.tool-versions` file looks like:

The versions can be in the following format:

- `10.15.0` - an actual version. Plugins that support downloading binaries, will download binaries.

- `ref:v1.0.2-a` or `ref:39cb398vb39` - tag/commit/branch to download from github and compile

- `path:/src/elixir` - a path to custom compiled version of a tool to use. For use by language developers and such.

- `system` - this keyword causes asdf to passthrough to the version of the tool on the system that is not managed by asdf.

To install all the tools defined in a `.tool-versions` file run `asdf install` with no other arguments in the directory containing the `.tool-versions` file.

Edit the file directly or use `asdf local` (or `asdf global`) which updates it.

Add a `.asdfrc` file to your home directory and asdf will use the settings specified in the file. The file should be formatted like this:

**Settings**

- `legacy_version_file` - defaults to `no`. If set to yes it will cause plugins that support this feature to read the version files used by other version managers (e.g. `.ruby-version` in the case of Ruby's `rbenv`).

- `ASDF_CONFIG_FILE` - Defaults to `~/.asdfrc` as described above. Can be set to any location.

- `ASDF_DEFAULT_TOOL_VERSIONS_FILENAME` - The name of the file storing the tool names and versions. Defaults to `.tool-versions`. Can be any valid file name.

- `ASDF_DATA_DIR` - Defaults to `~/.asdf` - Location where `asdf` install plugins, shims and installs. Can be set to any location before sourcing `asdf.sh` or `asdf.fish` mentioned in the section above.

Clone only the latest branch:

git clone https://github.com/asdf-vm/asdf.git ~/.asdf --branch v0.6.2

Alternately, you can clone the whole repo and checkout the latest branch:

git clone https://github.com/asdf-vm/asdf.git ~/.asdf

cd ~/.asdf

git checkout "$(git describe --abbrev=0 --tags)"

echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.bashrc

echo -e '\n. $HOME/.asdf/completions/asdf.bash' >> ~/.bashrc

echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.bash_profile

echo -e '\n. $HOME/.asdf/completions/asdf.bash' >> ~/.bash_profile

If you are using a framework, such as oh-my-zsh, use these lines. (Be sure

that if you make future changes to .zshrc these lines remain _below_ the line

where you source your framework.)

echo -e '\n. $HOME/.asdf/asdf.sh' >> ~/.zshrc

echo -e '\n. $HOME/.asdf/completions/asdf.bash' >> ~/.zshrc

If you are not using a framework, or if on starting your shell you get an

error message like 'command not found: compinit', then add this line before

the ones above.

autoload -Uz compinit && compinit

echo 'source ~/.asdf/asdf.fish' >> ~/.config/fish/config.fish

mkdir -p ~/.config/fish/completions; and cp ~/.asdf/completions/asdf.fish ~/.config/fish/completions

Restart your shell so that PATH changes take effect. (Opening a new terminal

tab will usually do it.)

If you're having issues with it not detecting the shims you've installed it's most-likely due to the sourcing of above `asdf.bash` or `asdf.fish` not being at the **BOTTOM** of your `~/.bash_profile`, `~/.zshrc`, or `~/.config/fish/config.fish`. It needs to be sourced **AFTER** you have set your `$PATH.`

For most plugins, it is good if you have installed the following packages OR their equivalent on your OS

Install these via homebrew:

coreutils automake autoconf openssl libyaml readline libxslt libtool unixodbc

automake autoconf libreadline-dev libncurses-dev libssl-dev libyaml-dev libxslt-dev libffi-dev libtool unixodbc-dev

automake autoconf readline-devel ncurses-devel openssl-devel libyaml-devel libxslt-devel libffi-devel libtool unixODBC-devel

**That's all ~! You are ready to use asdf**

asdf update

If you want the latest changes that aren't yet included in a stable release:

asdf update --head

1. In your `.bashrc` (or `.bash_profile` if you are on OSX) or `.zshrc` find the lines that source `asdf.sh` and the autocompletions. The lines should look something like this:

. $HOME/.asdf/asdf.sh

. $HOME/.asdf/completions/asdf.bash

Remove these lines and save the file.

2. Run `rm -rf ~/.asdf/` to completely remove all the asdf files from your system.

That's it!