wooksong/fenv

Simply flutter sdk version management

fenv

fenv is a CLI tool that helps manage multiple versions of flutter SDKs in your local machine. fenv does never require any other dependencies because it is implemented with bash only.

This is a premature hobby project and currently work-in-progress. This project is highly inspired by pyenv, which are mostly implemented with bash scripts.

Table of contents

• fenv
  • Table of contents
  • How to install
  • How to use
  • How to set local flutter SDK
  • Trouble shootings
    • If the .flutter-version file exists but not the corresponding flutter SDK isn't installed
    • When your VS Code could not find Dart PATH or Flutter SDK PATH

How to install

1. Execute the following command in your terminal:

   $ curl -sSL "https://raw.githubusercontent.com/powdream/fenv/main/init.sh" \
       | sh -

2. If you install fenv for the first time in your machine, then, you will see instruction like:

   # Please execute the following command and following instructions if you have not setup `fenv` yet:
   
   $HOME/.fenv/bin/fenv init

3. Execute $HOME/.fenv/bin/fenv init then follow the next instructions:
   • zsh:

     # Load fenv automatically by appending
     # the following to
     ~/.zprofile (for login shells)
     and ~/.zshrc (for interactive shells) :
     
     export FENV_ROOT="$HOME/.fenv"
     command -v fenv >/dev/null || export PATH="$FENV_ROOT/bin:$PATH"
     eval "$(fenv init -)"
     
     # Restart your shell for the changes to take effect.
     
     exec $SHELL -l

   • bash:

     # Load fenv automatically by appending``
     # the following to
     ~/.bash_profile if it exists, otherwise ~/.profile (for login shells)
     and ~/.bashrc (for interactive shells) :
     
     export FENV_ROOT="$HOME/.fenv"
     command -v fenv >/dev/null || export PATH="$FENV_ROOT/bin:$PATH"
     eval "$(fenv init -)"
     
     # Restart your shell for the changes to take effect.
     
     exec $SHELL -l

   • fish:

     # Add fenv executable to PATH by running
     # the following interactively:
     
     set -Ux FENV_ROOT $HOME/.fenv
     fish_add_path $FENV_ROOT/bin
     
     # Load fenv automatically by appending
     # the following to ~/.config/fish/conf.d/fenv.fish:
     
     fenv init - | source
     
     
     # Restart your shell for the changes to take effect.
     
     exec $SHELL -l

4. Remove FLUTTER_HOME, FLUTTER_SDK environmental variables if exist.
5. Eliminate any existing <FLUTTER_SDK>/bin from your PATH.

How to use

1. List-up available flutter SDKs.

   $ fenv install -l

2. Install any flutter SDK you want.

   $ fenv install <version>
   $ fenv versions
   <version>

3. Select the download SDK as the globally-using flutter SDK.

   $ fenv global <version>
   $ fenv version
   <version> (set by $HOME/.fenv/version)

4. Test if flutter is working correctly:

   $ flutter --version
   $ fenv which flutter

How to set local flutter SDK

1. CD to your flutter project directory and specify local version:

   $ cd PROJECT
   $ fenv local <local-version>

2. fenv will generate the following two files .flutter-version and .flutter symbolic link, which is a link to $HOME/.fenv/versions/<local-version>.
3. Test if flutter is working correctly:

   $ fenv version
   $ fenv which flutter
   $ flutter --version

4. We recommend staging .flutter-version to VCS, but not .flutter.
5. After change your local flutter version, do flutter clean and re-launch VS code.

Trouble shootings

If the .flutter-version file exists but not the corresponding flutter SDK isn't installed

1. If you run into an error message like:

   $ flutter
   fenv: no installed versions match the prefix '{VERSION}': try to execute 'fenv install && fenv local --symlink'

2. Then, following the instruction, please execute:

   $ fenv install
   $ fenv local --symlink

   or

   $ fenv install && fenv local --symlink

When your VS Code could not find Dart PATH or Flutter SDK PATH

• If you are using fenv local, please check if .flutter symlink is installed. If .flutter is not installed yet, fenv will let you know you need to execute fenv local --symlink[-s].
• If you are using fenv global, please run flutter pub get once and re-launch VS code.