mcluster

Files (1)

• SKILL.md

SKILL.md (first lines)

# mcluster Workflow

Use `bashscripts/mcluster` for local cluster lifecycle and diagnostics.

## Source the necessary paths 

source /root/.antigen/bundles/enricogolfieri/workspace-mongo-main/workspace-mongo.plugin.zsh

to load the necessary path and aliases

## Quick Start

```bash
mcluster setup
mcluster link <major>.<minor> (8.0). To link master we use "." which must be compiled via resmoke. 
mcluster init-cluster
mcluster status --json
```

`init*` commands initialize and start a cluster in one step.

## Core Commands

- `mcluster setup`: mandatory bootstrap; recreates `~/.mcluster/.venv`, installs tools, and cleans prior cluster state/processes.
- `mcluster link .`: use local repo binaries (`./bazel-bin/install/bin`).
- `mcluster link <version>`: activate/install via `m`, then link that version.
- `mcluster initd|init-replica|init-lite|init-cluster`: create and start cluster layouts.
- `mcluster start`: restart an already-initialized cluster.
- `mcluster status --json`: machine-readable cluster state (`mongos`, `mongod`, `primary`).
- `mcluster binary --json`: show resolved binary paths and versions for troubleshooting.

## Troubleshooting Order

1. Run `mcluster setup` if any command says setup is missing or stale.
2. Run `mcluster binary --json` to confirm `mongod`/`mongos` resolution.
3. If `.mongo_paths` is missing, run `mcluster link .` or `mcluster link <version>`.
4. If startup metadata is missing, run an `init*` command before `start`.

## AI Usage Notes

- Prefer `mcluster status --json` for automation and summaries.
- Report:
  - `mongos` ports
  - `mongod` ports
  - `primary`
  - `running` flag
- On failures, include the exact remediation command shown by `mcluster`.

From enricogolfieri/workspace-mongo, Unlicense.

More from enricogolfieri/workspace-mongo