https://github.com/seamapi/seam-cli
Command line interface for the Seam API
https://github.com/seamapi/seam-cli
maintained
Last synced: 3 months ago
JSON representation
Command line interface for the Seam API
- Host: GitHub
- URL: https://github.com/seamapi/seam-cli
- Owner: seamapi
- Created: 2023-12-10T20:42:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-02T15:04:25.000Z (3 months ago)
- Last Synced: 2025-04-02T16:22:41.812Z (3 months ago)
- Topics: maintained
- Language: TypeScript
- Homepage:
- Size: 1.19 MB
- Stars: 84
- Watchers: 5
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# seam-cli - Seam Command Line Interface
A command line for interacting with [the Seam API](https://seam.co), create a [free account at console.seam.co](https://console.seam.co)
## Installation
For npm users:
```bash
npm install -g seam-cli
```
For brew users:
```bash
brew tap seamapi/homebrew-seam
brew install seam
```
## Usage
Every `seam` command is interactive and will prompt you for any missing
required properties with helpful suggestions. To avoid automatic behavior,
pass `-y`
```bash
# Login to Seam
seam login
# Select your workspace
seam select workspace
# Interactively select commands to execute
seam
# Create a connect webview to connect devices
seam connect-webviews create
# List devices in your workspace
seam devices list
MY_DOOR=$(seam devices get --name "Front Door" --id-only)
# Unlock a lock
seam locks unlock-door --device-id $MY_DOOR
# Create an access code
seam access-codes create --code "1234" --name "My Code"
# List you access codes
seam access-codes list --device-id $MY_DOOR
```