https://github.com/temporalio/cli
Command-line interface for running Temporal Server and interacting with Workflows, Activities, Namespaces, and other parts of Temporal
https://github.com/temporalio/cli
ci go temporal workflow-engine
Last synced: 5 days ago
JSON representation
Command-line interface for running Temporal Server and interacting with Workflows, Activities, Namespaces, and other parts of Temporal
- Host: GitHub
- URL: https://github.com/temporalio/cli
- Owner: temporalio
- License: mit
- Created: 2022-10-30T22:31:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T22:06:24.000Z (9 months ago)
- Last Synced: 2025-05-12T05:13:38.923Z (9 months ago)
- Topics: ci, go, temporal, workflow-engine
- Language: Go
- Homepage: https://docs.temporal.io/cli
- Size: 13.8 MB
- Stars: 282
- Watchers: 13
- Forks: 47
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Temporal CLI
Temporal command-line interface and development server.
**[DOCUMENTATION](https://docs.temporal.io/cli)**
## Quick Install
Reference [the documentation](https://docs.temporal.io/cli) for detailed install information.
### Install via Homebrew
brew install temporal
### Install via download
1. Download the version for your OS and architecture:
- [Linux amd64](https://temporal.download/cli/archive/latest?platform=linux&arch=amd64)
- [Linux arm64](https://temporal.download/cli/archive/latest?platform=linux&arch=arm64)
- [macOS amd64](https://temporal.download/cli/archive/latest?platform=darwin&arch=amd64)
- [macOS arm64](https://temporal.download/cli/archive/latest?platform=darwin&arch=arm64) (Apple silicon)
- [Windows amd64](https://temporal.download/cli/archive/latest?platform=windows&arch=amd64)
2. Extract the downloaded archive.
3. Add the `temporal` binary to your `PATH` (`temporal.exe` for Windows).
### Run via Docker
[Temporal CLI on DockerHub](https://hub.docker.com/r/temporalio/temporal)
docker run --rm temporalio/temporal --help
Note that for dev server to be accessible from host system, it needs to listen on external IP and the ports need to be forwarded:
docker run --rm -p 7233:7233 -p 8233:8233 temporalio/temporal:latest server start-dev --ip 0.0.0.0
# UI is now accessible from host at http://localhost:8233/
### Build
1. Install [Go](https://go.dev/)
2. Clone repository
3. Switch to cloned directory, and run `go build ./cmd/temporal`
The executable will be at `temporal` (`temporal.exe` for Windows).
## Usage
Reference [the documentation](https://docs.temporal.io/cli) for detailed usage information.
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).