Skip to content

Commit 81f4a19

Browse files
Merge pull request #2009 from mrueg/docs/homebrew
docs(cli): Add homebrew install method
2 parents 21fb9e8 + 8eec87c commit 81f4a19

9 files changed

Lines changed: 42 additions & 1 deletion

File tree

advent-of-calm/day-1.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,16 @@ git init
2121
```
2222

2323
### 2. Install the CALM CLI
24+
Install via npm:
2425
```bash
2526
npm install -g @finos/calm-cli
2627
```
2728

29+
or if you use [Homebrew](https://brew.sh):
30+
```shell
31+
brew install calm-cli
32+
```
33+
2834
Verify installation:
2935
```bash
3036
calm --version

advent-of-calm/home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Before you begin, make sure you have:
3131
### Your First Steps
3232

3333
1. **Create your repository** - Set up a git repository to track your progress
34-
2. **Install the CALM CLI** - `npm install -g @finos/calm-cli`
34+
2. **Install the CALM CLI** - `npm install -g @finos/calm-cli` or `brew install calm-cli` if you use [Homebrew](https://brew.sh)
3535
3. **Start with Day 1** - Click on the calendar to begin your journey
3636
4. **Commit daily** - Track your progress with git commits and tags
3737

advent-of-calm/setup.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@ To update the CALM CLI to the latest version, run:
2020
npm install -g @finos/calm-cli
2121
```
2222

23+
or if you use [Homebrew](https://brew.sh):
24+
```shell
25+
brew install calm-cli
26+
```
27+
2328
This will fetch and install the latest release from npm. We recommend doing this regularly, especially if you encounter any issues or want to use new features.
2429

2530
### Verify the Update

calm-ai/tools/calm-cli-instructions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ Install globally via npm:
1010
npm install -g @finos/calm-cli
1111
```
1212

13+
or if you use [Homebrew](https://brew.sh):
14+
```shell
15+
brew install calm-cli
16+
```
17+
1318
Run `calm` with no arguments to see the top-level help:
1419

1520
```shell

calm/getting-started/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,11 @@ following command:
8585
npm install -g @finos/calm-cli
8686
```
8787

88+
or if you use [Homebrew](https://brew.sh):
89+
```shell
90+
brew install calm-cli
91+
```
92+
8893
Verify the installation.
8994

9095
```shell

cli/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ Install the CLI on to your machine with this command:
1313
% npm install -g @finos/calm-cli
1414
```
1515

16+
or if you use [Homebrew](https://brew.sh):
17+
```shell
18+
brew install calm-cli
19+
```
20+
1621
Type `calm` into your terminal, and you should see the help text printed out.
1722

1823
```shell

docs/docs/introduction/what-is-calm.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ To start using CALM, you can install the CALM CLI and begin exploring its capabi
6565
```shell
6666
npm install -g @finos/calm-cli
6767
```
68+
69+
or if you use [Homebrew](https://brew.sh):
70+
```shell
71+
brew install calm-cli
72+
```
6873
2. **Explore the CLI Commands**: Use the CLI to generate and validate architectural patterns and architectures.
6974
3. **Join the Community**: Contribute to the CALM monorepo, engage with other architects, and help evolve the standard.
7075

docs/docs/working-with-calm/installation.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ To install the CALM CLI globally on your machine, run the following command in y
2323
npm install -g @finos/calm-cli
2424
```
2525

26+
or if you use [Homebrew](https://brew.sh):
27+
```shell
28+
brew install calm-cli
29+
```
30+
2631
Once the installation is complete, you can verify that the CLI is installed correctly by typing:
2732

2833
```shell

docs/quick-start/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@ following command:
9797
npm install -g @finos/calm-cli
9898
```
9999

100+
or if you use [Homebrew](https://brew.sh):
101+
```shell
102+
brew install calm-cli
103+
```
104+
100105
Verify the installation.
101106

102107
```shell

0 commit comments

Comments
 (0)