webarcade 0.5.0

CLI for WebArcade - Create and build native desktop app plugins
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# webarcade-cli


CLI for [WebArcade](https://github.com/warcade/core) - Create and build native desktop app plugins.

## Installation


```bash
cargo install webarcade
```

## Quick Start


```bash
# Initialize a new project

webarcade init my-app
cd my-app

# Create a new plugin

webarcade new my-plugin

# Build the plugin

webarcade build my-plugin

# Run the app

webarcade run

# Package the app

webarcade package
```

## Commands


| Command | Description |
|---------|-------------|
| `webarcade init <name>` | Initialize a new WebArcade project |
| `webarcade new <plugin>` | Create a new plugin |
| `webarcade build <plugin>` | Build a plugin |
| `webarcade build --all` | Build all plugins |
| `webarcade list` | List available plugins |
| `webarcade run` | Build and run the app |
| `webarcade app` | Build production app with installer |
| `webarcade package` | Package app for distribution (interactive) |
| `webarcade install <user/repo>` | Install a plugin from GitHub |
| `webarcade update` | Update the CLI to latest version |

## Build Optimizations


The CLI includes smart build caching to speed up development:

### Incremental Plugin Builds


Plugins are only rebuilt when their source files change. The CLI tracks file hashes and skips unchanged plugins:

```bash
# Only rebuilds plugins that have changed

webarcade build --all

# Force rebuild all plugins (ignore cache)

webarcade build --all -f
```

### Build Flags


| Flag | Description |
|------|-------------|
| `-f, --force` | Force rebuild, ignoring cache |

### Package Flags


| Flag | Description |
|------|-------------|
| `--locked` | Embed plugins in binary (locked mode) |
| `--no-rebuild` | Only rebuild changed plugins (use cache) |
| `--skip-binary` | Skip frontend/binary rebuild (use existing) |
| `--skip-prompts` | Use current config without prompts |

### Common Workflows


```bash
# Full rebuild and package

webarcade package --locked

# Only 1 plugin changed, rebuild just that plugin

webarcade package --no-rebuild --locked

# Plugin changed, binary unchanged (unlocked mode only)

webarcade package --no-rebuild --skip-binary

# Quick repackage with no rebuilds

webarcade package --no-rebuild --skip-binary --skip-prompts
```

## Automatic Process Management


The CLI automatically terminates running app processes before building to prevent "file in use" errors. This happens automatically when you run:

- `webarcade build`
- `webarcade app`
- `webarcade package`

## Build Cache


Plugin build state is stored in `build/.build_cache.json`. The cache tracks:

- SHA-256 hash of all source files (`.rs`, `.jsx`, `.js`, `.ts`, `.tsx`, `.json`, `.toml`, `.css`, `.scss`)
- Build timestamp

Changes that trigger a rebuild:
- Any source file content change
- Adding/removing/renaming files
- Missing output file (`.dll`, `.js`)
- Using `--force` flag

Changes that don't trigger a rebuild:
- Lock file changes (`package-lock.json`, `Cargo.lock`)
- `node_modules/` or `target/` changes
- File timestamp changes without content changes

## License


MIT