Skip to content

installation.md

Latest commit

 

History

History
157 lines (106 loc) · 4.64 KB

installation.md

File metadata and controls

157 lines (106 loc) · 4.64 KB
Raw

Installation

This document describes how to install Shiba.

Runtime dependencies

Shiba uses platform-specific WebView runtimes through wry crate. You may need to install runtime dependencies on some platforms.

Ubuntu or Debian

On Linux, Shiba uses GTKWebKit. Some additional shared libraries need to be installed via system package manager.

# On Ubuntu or Debian
sudo apt install libwebkit2gtk-4.1-dev libxdo-dev libgtk-3-dev

# On Fedora
sudo dnf install gtk3-devel webkit2gtk4.1-devel libxdo

# On Arch Linux
sudo pacman -S webkit2gtk-4.1 gtk3 xdotool

Note: If you install .deb file through dpkg command, these dependencies are automatically installed.

Windows

Shiba uses WebView2 component. Usually it is already installed because Windows 11 and Windows 10 version 1803 or later install it by default. When you see Shiba crashes on startup, please check if WebView2 is installed.

macOS

Shiba uses WKWebView and it is installed by default on macOS. No additional dependency is necessary.

Use Pre-built binaries

Warning

These artifacts are still alpha releases. They may be buggy.

Pre-built binaries are hosted on the release page.

  • .zip files are archived single binaries for each platforms. Put the executable binary to your $PATH directory
  • .msi file is a Windows installer. Double-click it and follow the instructions
  • .deb file is a package for Debian and Ubuntu. Install it via dpkg and manage it with apt
  • .dmg file is a universal macOS package which supports both M1 Mac and Intel Mac. Double-click it and move the .app file to Applications directory

Note: These executables are not signed. When your OS complains about it, go to 'Security' OS settings and allow the executable to run.

Use Cargo package manager

Shiba is released on crates.io. shiba executable can be installed as a crate.

Warning

Packages uploaded to crates.io are experimental alpha releases. You need to specify the full version string at cargo install.

When you install version 2.0.0-alpha.1, run the following command.

cargo install shiba-preview@2.0.0-alpha.1

After the installation check the version is what you expect.

shiba --version

Note

The executable is assumed to be used in command line. It is not packaged as application like Shiba.app on macOS.

Build from source and package as desktop app

Preparation

Shiba is built with Rust and TypeScript. Install Cargo package manager via rustup and Node.js as build toolchain. Ensure that the latest stable Rust toolchain and the latest LTS version of Node.js are installed.

All build tasks are defined as make rules. On Windows, install Make via winget or chocolatey.

Clone the Shiba Git repository from GitHub.

git clone --depth=1 'https://github.com/rhysd/Shiba.git'
cd ./Shiba

As an optional step check out specific tag to build.

git checkout v2.0.0-alpha.1

Build single-binary executable

To build shiba (or shiba.exe on Windows) single-binary executable as CLI application, run make release. It generates an executable in target/release directory. Put it to your $PATH directory.

make release
./target/release/shiba --help

Build macOS universal application

Targets for both arm64 Mac and x86_64 Mac are necessary. Install them via rustup:

rustup target add x86_64-apple-darwin aarch64-apple-darwin

make does everything to generate Shiba.dmg or Shiba.app.

# At the root of the repository
make Shiba.dmg
# or
make Shiba.app

Build Windows installer

WiX v4 is needed. Ensure wix command works in your terminal.

make does everything to generate shiba.msi installer file.

# At the root of the repository
make shiba.msi

Build Debian or Ubuntu package

cargo-deb is needed. Ensure cargo deb command works in your terminal.

make does everything to generate shiba_amd64.deb package file.

# At the root of the repository
make shiba_amd64.deb