forked from uber/cadence
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme for CLI homebrew (uber#4135)
Docs change only.
- Loading branch information
1 parent
d53e631
commit 45ef498
Showing
7 changed files
with
24 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,3 @@ | ||
Documentation for the Cadence command line interface is located at our [main site](https://cadenceworkflow.io/docs/cli/). | ||
|
||
## Quick Start | ||
Run `make cadence` from the project root. You should see an executable file called `cadence`. Try a few example commands to | ||
get started: | ||
`./cadence` for help on top level commands and global options | ||
`./cadence domain` for help on domain operations | ||
`./cadence workflow` for help on workflow operations | ||
`./cadence tasklist` for help on tasklist operations | ||
(`./cadence help`, `./cadence help [domain|workflow]` will also print help messages) | ||
|
||
**Note:** Make sure you have a Cadence server running before using the CLI. | ||
|
||
## Homebrew | ||
Cadence CLI homebrew formula is maintain by [a community project](https://github.com/git-hulk/homebrew-cadence): | ||
``` | ||
% brew tap git-hulk/cadence | ||
% brew install cadence-cli | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters