Installation

LexicMap can be installed via conda, downloading executable binary files, or compiling from the source.

Besides, it supports shell completion, which could help accelerate typing.

Conda

conda install -c bioconda lexicmap

Or use mamba, which is faster.

conda install -c conda-forge mamba
mamba install -c bioconda lexicmap

Linux and MacOS (both x86 and arm CPUs) are supported.

Binary files

Linux

Download the binary file.

OS	Arch	File, 中国镜像
Linux	64-bit	lexicmap_linux_amd64.tar.gz, 中国镜像
Linux	arm64	lexicmap_linux_arm64.tar.gz, 中国镜像

Decompress it:
```
 tar -zxvf lexicmap_linux_amd64.tar.gz
```
If you have the root privilege, simply copy it to /usr/local/bin:
```
 sudo cp lexicmap /usr/local/bin/
```

If you don’t have the root privilege, copy it to any directory in the environment variable PATH:

 mkdir -p $HOME/bin/; cp lexicmap $HOME/bin/

And optionally add the directory into the environment variable PATH if it’s not in.

 # bash
 echo export PATH=\$PATH:\$HOME/bin/ >> $HOME/.bashrc
 source $HOME/.bashrc # apply the configuration

 # zsh
 echo export PATH=\$PATH:\$HOME/bin/ >> $HOME/.zshrc
 source $HOME/.zshrc # apply the configuration

MacOS

Download the binary file.

OS	Arch	File, 中国镜像
macOS	64-bit	lexicmap_darwin_amd64.tar.gz, 中国镜像
macOS	arm64	lexicmap_darwin_arm64.tar.gz, 中国镜像

Copy it to any directory in the environment variable PATH:

 mkdir -p $HOME/bin/; cp lexicmap $HOME/bin/

And optionally add the directory into the environment variable PATH if it’s not in.

 # bash
 echo export PATH=\$PATH:\$HOME/bin/ >> $HOME/.bashrc
 source $HOME/.bashrc # apply the configuration

 # zsh
 echo export PATH=\$PATH:\$HOME/bin/ >> $HOME/.zshrc
 source $HOME/.zshrc # apply the configuration

Windows

Download the binary file.

OS Arch File, 中国镜像

Windows 64-bit lexicmap_windows_amd64.exe.tar.gz, 中国镜像
Decompress it.
Copy lexicmap.exe to C:\WINDOWS\system32.

OS	Arch	File, 中国镜像
Windows	64-bit	lexicmap_windows_amd64.exe.tar.gz, 中国镜像

Others

Please open an issue to request binaries for other platforms.
Or compiling from the source.

Compile from the source

Install go (go 1.22 or later versions).

 wget https://go.dev/dl/go1.22.6.linux-amd64.tar.gz

 tar -zxf go1.22.6.linux-amd64.tar.gz -C $HOME/

 # or
 #   echo "export PATH=$PATH:$HOME/go/bin" >> ~/.bashrc
 #   source ~/.bashrc
 export PATH=$PATH:$HOME/go/bin

Compile LexicMap.

 # ------------- the latest stable version -------------

 go get -v -u github.com/shenwei356/LexicMap/lexicmap

 # The executable binary file is located in:
 #   ~/go/bin/lexicmap
 # You can also move it to anywhere in the $PATH
 mkdir -p $HOME/bin
 cp ~/go/bin/lexicmap $HOME/bin/


 # --------------- the development version --------------

 git clone https://github.com/shenwei356/LexicMap
 cd LexicMap/lexicmap/
 go build

 # The executable binary file is located in:
 #   ./lexicmap
 # You can also move it to anywhere in the $PATH
 mkdir -p $HOME/bin
 cp ./lexicmap $HOME/bin/

Shell-completion

Supported shell: bash|zsh|fish|powershell

Bash:

# generate completion shell
lexicmap autocompletion --shell bash

# configure if never did.
# install bash-completion if the "complete" command is not found.
echo "for bcfile in ~/.bash_completion.d/* ; do source \$bcfile; done" >> ~/.bash_completion
echo "source ~/.bash_completion" >> ~/.bashrc

Zsh:

# generate completion shell
lexicmap autocompletion --shell zsh --file ~/.zfunc/_kmcp

# configure if never did
echo 'fpath=( ~/.zfunc "${fpath[@]}" )' >> ~/.zshrc
echo "autoload -U compinit; compinit" >> ~/.zshrc

fish:

lexicmap autocompletion --shell fish --file ~/.config/fish/completions/lexicmap.fish