0
# Moon CLI Tool
1

2
Moon is a repository management, organization, orchestration, and notification tool for the web ecosystem, written in Rust. It provides comprehensive capabilities for managing monorepos, handling dependencies, executing tasks, and coordinating builds across multiple projects.
3

4
## Package Information
5

6
- **Package Name**: @moonrepo/core-macos-x64
7
- **Package Type**: npm (binary distribution)
8
- **Language**: JavaScript/Node.js (wrapper for Rust binary)
9
- **Platform**: macOS x64 (Intel)
10
- **Installation**: Automatically installed as optional dependency via `@moonrepo/cli`
11

12
## Installation
13

14
This package provides the macOS x64 binary for the moon CLI tool. It's automatically selected as an optional dependency when installing the main CLI package on compatible systems:
15

16
```bash
17
# Install the main CLI package (includes this binary)
18
npm install @moonrepo/cli
19

20
# Or install globally
21
npm install -g @moonrepo/cli
22

23
# Alternatively, install with script
24
curl -fsSL https://moonrepo.dev/install/moon.sh | bash
25
```
26

27
The `@moonrepo/core-macos-x64` package contains the compiled `moon` binary and is automatically used by the CLI package on macOS x64 systems. Users typically don't install this package directly.
28

29
## Basic Usage
30

31
```bash
32
# Initialize a new moon repository
33
moon init
34

35
# Run tasks for affected projects
36
moon run build
37

38
# Check all projects
39
moon check
40

41
# View project information
42
moon project my-app
43

44
# Display interactive project graph
45
moon project-graph
46
```
47

48
## Architecture
49

50
Moon is built around several key components:
51

52
- **Repository Management**: Multi-project repository organization and dependency tracking
53
- **Task Orchestration**: Parallel task execution with dependency resolution
54
- **Build System**: Smart caching, incremental builds, and remote caching
55
- **Toolchain Management**: Automatic tool installation and version management
56
- **Graph Visualization**: Interactive dependency and task graphs
57
- **Code Generation**: Template-based scaffolding and file generation
58

59
## Capabilities
60

61
### Environment Management
62

63
Commands for initializing, setting up, and managing the moon environment.
64

65
```bash { .api }
66
moon completions [--shell <SHELL>]
67
moon init [toolchain] [plugin] [--to <PATH>] [--force] [--minimal] [--yes]
68
moon setup
69
moon teardown
70
```
71

72
[Environment Management](./environment.md)
73

74
### Toolchain Management
75

76
Commands for managing development tools and runtime environments.
77

78
```bash { .api }
79
moon bin <tool>
80
moon node <subcommand>
81
moon toolchain <subcommand>
82
```
83

84
[Toolchain Management](./toolchain.md)
85

86
### Project & Task Management
87

88
Commands for working with projects and tasks within the repository.
89

90
```bash { .api }
91
moon project <id> [--json] [--no-tasks]
92
moon task <target> [--json]
93
moon sync [subcommand]
94
```
95

96
[Project & Task Management](./project-task.md)
97

98
### Task Execution
99

100
Commands for running builds, tests, and other tasks across projects.
101

102
```bash { .api }
103
moon check [ids...] [--all] [--summary] [--update-cache]
104
moon ci [targets...] [--base <REF>] [--head <REF>] [--job <INDEX>] [--job-total <TOTAL>] [--stdin]
105
moon run <targets...> [--dependents] [--force] [--interactive] [--query <QUERY>] [--summary]
106
```
107

108
[Task Execution](./execution.md)
109

110
### Graph Visualization
111

112
Commands for visualizing project and task dependencies through interactive graphs.
113

114
```bash { .api }
115
moon action-graph [targets...] [--dependents] [--host <HOST>] [--port <PORT>]
116
moon project-graph [id] [--dependents] [--host <HOST>] [--port <PORT>]
117
moon task-graph [target] [--dependents] [--host <HOST>] [--port <PORT>]
118
```
119

120
[Graph Visualization](./graphs.md)
121

122
### Code Generation
123

124
Commands for generating code from templates and managing templates.
125

126
```bash { .api }
127
moon generate <name> [dest] [--defaults] [--dry-run] [--force] [--template]
128
moon templates [--filter <PATTERN>] [--json]
129
```
130

131
[Code Generation](./generation.md)
132

133
### Query & Analysis
134

135
Commands for querying information about projects, tasks, and the build pipeline.
136

137
```bash { .api }
138
moon query hash <hash> [--json]
139
moon query hash-diff <left> <right> [--json]
140
moon query projects [query] [--alias <ALIAS>] [--affected] [--json] [--language <LANG>] [--tags <TAGS>]
141
moon query tasks [query] [--affected] [--command <COMMAND>] [--json] [--project <PROJECT>]
142
moon query touched-files [--base <REF>] [--head <REF>] [--json] [--local] [--remote]
143
```
144

145
[Query & Analysis](./query.md)
146

147
### Extensions & Integration
148

149
Commands for working with plugins, extensions, and external integrations.
150

151
```bash { .api }
152
moon ext <id> [-- args...]
153
moon mcp
154
moon docker <subcommand>
155
moon migrate <subcommand> [--skip-touched-files-check]
156
```
157

158
[Extensions & Integration](./extensions.md)
159

160
### Maintenance & Utilities
161

162
Commands for maintaining the workspace and managing moon itself.
163

164
```bash { .api }
165
moon clean [--lifetime <DURATION>]
166
moon upgrade
167
```
168

169
[Maintenance & Utilities](./maintenance.md)
170

171
### Debugging & Development
172

173
Internal debugging commands for development and troubleshooting.
174

175
```bash { .api }
176
moon debug config
177
moon debug vcs
178
```
179

180
[Maintenance & Utilities](./maintenance.md)
181

182
## Global Options
183

184
All moon commands support the following global options:
185

186
```bash { .api }
187
--cache <MODE>           # Mode for cache operations (default: read-write)
188
--color                  # Force colored output
189
--concurrency <NUM>      # Maximum number of threads to utilize (-c)
190
--dump                   # Dump a trace profile to the working directory
191
--log <LEVEL>            # Lowest log level to output (off|error|warn|info|debug|trace)
192
--log-file <PATH>        # Path to a file to write logs to
193
--quiet                  # Hide all non-important terminal output (-q)
194
--theme <THEME>          # Terminal theme to print with (dark|light)
195
```
196

197
## Environment Variables
198

199
Moon behavior can be configured through environment variables:
200

201
- `MOON_CACHE` - Cache operation mode
202
- `MOON_CONCURRENCY` - Maximum thread utilization
203
- `MOON_DUMP` - Enable trace profiling
204
- `MOON_HOST` - Graph server host address
205
- `MOON_LOG` - Log level setting
206
- `MOON_LOG_FILE` - Log file path
207
- `MOON_PORT` - Graph server port
208
- `MOON_QUIET` - Quiet mode toggle
209
- `MOON_SUMMARY` - Action summary toggle
210
- `MOON_THEME` - Terminal theme setting
211
- `MOON_VERSION` - Moon version (set automatically)
212
- `STARBASE_LOG` - Starbase logging configuration
213

214
## Exit Codes
215

216
Moon commands return standard exit codes:
217
- `0` - Success
218
- `1` - General error
219
- Other codes may be returned based on specific command failures