74 lines
2.6 KiB
Plaintext
74 lines
2.6 KiB
Plaintext
---
|
||
title: Get Started
|
||
description: This guide will walk you through installing the Mist CLI, setting up your development environment, and compiling your very first program.
|
||
icon: Rocket
|
||
---
|
||
|
||
For any Questions you may have about mist, [visit the FAQ here](/faq).
|
||
|
||
## 1. Installation
|
||
|
||
Mist is currently distributed as a Cargo crate. To get started, you'll need to have the Rust toolchain installed.
|
||
|
||
Run the following command to install the Mist toolchain:
|
||
|
||
```bash title="Terminal"
|
||
cargo install [email protected]
|
||
```
|
||
|
||
> (ℹ) For a more streamlined development experience, Install the following VSCode extensions:
|
||
> 1. [Mist syntax highlighting VSCode extension](https://marketplace.visualstudio.com/items?itemName=selimaj-dev.mist-syntax)
|
||
> 2. [Mist analyzer LSP VSCode extension](https://marketplace.visualstudio.com/items?itemName=selimaj-dev.mist-analyzer)
|
||
|
||
Once the installation finishes, verify it by checking the version:
|
||
|
||
```bash title="Terminal"
|
||
mist version
|
||
```
|
||
|
||
---
|
||
|
||
## 2. Setting Up Your Mist Project
|
||
```bash
|
||
mist new mist-hello-world
|
||
```
|
||
or
|
||
```bash
|
||
mist init
|
||
```
|
||
|
||
|
||
```mist title="src/main.mist"
|
||
void main() {
|
||
println!("Hello World!");
|
||
}
|
||
```
|
||
|
||
### 3. Build and Run
|
||
|
||
```bash title="Terminal"
|
||
mist run
|
||
```
|
||
|
||
---
|
||
|
||
## Command Reference
|
||
|
||
| Command | Alias | Description |
|
||
| -------------------- | ----- | ----------------------------------------------- |
|
||
| mist run |r| |run the project |
|
||
| mist build |b| |build the project |
|
||
| mist transpile |t |transpile the project |
|
||
| mist check |c |check the project |
|
||
| mist test| |test the project |
|
||
| mist publish| |publish the project |
|
||
| mist bench| |benchmark the project |
|
||
| mist doc| |build documentation |
|
||
| mist fix| |automatically fix warnings |
|
||
| mist clippy| |lint the project |
|
||
| mist clean| |clean build artifacts |
|
||
| mist init| |initialize a project in the current folder |
|
||
| mist new| |create a new project |
|
||
| mist version|-v |print the compiler version |
|
||
| mist help|-h |print this message |
|