Skip to content

Commit

Permalink
Rough readme
Browse files Browse the repository at this point in the history
  • Loading branch information
willosborne committed Feb 11, 2025
1 parent ee4cf68 commit ea15b32
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,28 @@ Commands:
help [command] display help for command
```

### Configuring the CLI to fetch schemas from CALMHub

The CLI supports two operating modes: CALMHub and the local file system.

In file system mode, schemas are loaded from a directory on startup.
By passing the `--schemaDirectory` option this mode is enabled.
All files within this directory will be recursively loaded.

In CALMHub mode, a URL is required for where to find CALMHub.
This can be provided either by `--calmHubUri` or via a central config file in your home directory.

This file should be created in the user's home directory, with filename '.calm.json'.
As a Unix style file path: '~/.calm.json'

This file should look like the following:

```json
{
"calmHubUrl": "https://my-calmhub.com"
}
```

### Generating an architecture from a CALM pattern file

This command lets you create a shell of an architecture from a pattern file.
Expand Down

0 comments on commit ea15b32

Please sign in to comment.