mirror of
https://github.com/wailsapp/wails.git
synced 2025-05-03 01:43:15 +08:00
60 lines
1.9 KiB
Plaintext
60 lines
1.9 KiB
Plaintext
---
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# Installation
|
|
|
|
## Supported Platforms
|
|
|
|
- Windows 10/11 AMD64/ARM64
|
|
- MacOS 10.13+ AMD64
|
|
- MacOS 11.0+ ARM64
|
|
- Linux AMD64/ARM64
|
|
|
|
## Dependencies
|
|
|
|
Wails has a number of common dependencies that are required before installation:
|
|
|
|
- Go 1.17+
|
|
- NPM (Node 15+)
|
|
|
|
### Go
|
|
|
|
Download Go from the [Go Downloads Page](https://go.dev/doc/install).
|
|
|
|
Ensure that you follow the official [Go installation instructions](https://go.dev/doc/install). You will also need to ensure that your `PATH` environment variable also includes the path to your `~/go/bin` directory. Restart your terminal and do the following checks:
|
|
|
|
- Check Go is installed correctly: `go version`
|
|
- Check "~/go/bin" is in your PATH variable: `echo $PATH | grep go/bin`
|
|
|
|
### NPM
|
|
|
|
Download NPM from the [Node Downloads Page](https://nodejs.org/en/download/). It is best to use the latest release as that is what we generally test against.
|
|
|
|
Run `npm --version` to verify.
|
|
|
|
## Platform Specific Dependencies
|
|
|
|
You will also need to install platform specific dependencies:
|
|
|
|
import TabsInstaller from "../../src/components/tabinstall";
|
|
<TabsInstaller />
|
|
|
|
## Optional Dependencies
|
|
|
|
- [UPX](https://upx.github.io/) for compressing your applications.
|
|
|
|
## Installing Wails
|
|
|
|
Run `go install github.com/wailsapp/wails/v2/cmd/wails@latest` to install the Wails CLI.
|
|
|
|
## System Check
|
|
|
|
Running `wails doctor` will check if you have the correct dependencies installed. If not, it will advise on what is missing and help on how to rectify any problems.
|
|
|
|
## The `wails` command appears to be missing?
|
|
|
|
If your system is reporting that the `wails` command is missing, make sure you have followed the Go installation guide
|
|
correctly. Normally, it means that the `go/bin` directory in your User's home directory is not in the `PATH` environment
|
|
variable. You will also normally need to close and reopen any open command prompts so that changes to the environment
|
|
made by the installer are reflected at the command prompt. |