microcad 0.2.20

µcad Command Line Interface
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# microcad

This crate provides the command line interpreter of µcad.

**Note**: This project is in an early stage of development and is not yet feature complete!

## Installation

First, install [CMake](https://cmake.org/) and [Ninja](https://github.com/ninja-build/ninja) which are needed to compile
the [manifold geometry library](https://github.com/elalish/manifold).

### *Debian* based *Linux* distributions

Use the following line to install Ninja and CMake:

```sh
sudo apt install ninja-build cmake
```

### MacOS

If you are on using MacOS, you have to install `cmake` and `ninja` using `brew`:

```sh
brew install cmake ninja
```

### Install µcad via cargo

To install the latest release of *µcad* via *cargo*, type:

```sh
cargo install microcad
```

## Command line usage

After installing, you can run a basic example by typing:

```sh
microcad eval ./examples/bricks/brick
```

This will *evaluate* the input file and will output the model tree.
The *evaluate* command will not export the output geometry.

To generate an STL model file use the `export` command with an additional output file name:

```sh
microcad export ./examples/bricks/brick
```

## Run

Start the microcad CLI by typing `microcad` into your console.

```sh
microcad
```

This will give you an overview of the available functionality:

```plain
µcad Command Line Interface

Usage: microcad [OPTIONS] <COMMAND>

Commands:
  parse    Parse a µcad file
  resolve  Parse and resolve a µcad file
  eval     Parse and evaluate a µcad file
  export   Parse and evaluate and export a µcad file
  create   Create a new source file with µcad extension
  watch    Watch a µcad file
  install  Install µcad standard library
  help     Print this message or the help of the given subcommand(s)

Options:
  -T, --time             Display processing time
  -C, --config <CONFIG>  Load config from file
  -v...                  Verbosity level (use -v, -vv, or -vvv)
  -h, --help             Print help
  -V, --version          Print version
```

## Install standard library

In most cases you might want to use the *µcad standard library* (`std`).

This must be installed once by running the following command:

```sh
microcad install std
```

You're now ready to use µcad!

## Resources

- Tutorials:

  - <http://microcad.xyz>  
- Language documentation:

  - <https://docs.microcad.xyz/language/book/index.html>