https://github.com/filledstacks/session_mate_cli
CLI to interact with SessionMate
https://github.com/filledstacks/session_mate_cli
Last synced: 10 months ago
JSON representation
CLI to interact with SessionMate
- Host: GitHub
- URL: https://github.com/filledstacks/session_mate_cli
- Owner: FilledStacks
- Created: 2023-08-10T04:04:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-01T14:48:23.000Z (about 2 years ago)
- Last Synced: 2025-03-19T21:14:58.373Z (10 months ago)
- Language: Dart
- Size: 5.38 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Session Mate CLI
The companion of Session Mate is a CLI app called **sessionmate**. Is in charge of the replay of the sessions. Also, allows the user to login, logout, register an application and register a user.
## Installation
### macOS
The installation of the CLI is through the package manager Homebrew.
Install our Brew Repository known as Tap.
```bash
brew tap filledstacks/tap
```
Then install the package.
```bash
brew install sessionmate
```
## Upgrade
To upgrade sessionmate CLI you can execute the following command:
```bash
brew upgrade filledstacks/tap/sessionmate
```
## Get Started
> For **session mate** to be able to replay a session it must be a device running on your computer.
> - Emulator supported: Android and iOS
> - Devices supported: Android
To launch the app through sessionmate CLI run
```bash
sessionmate drive -p .
```
If you need to pass additional commands like **flavor** information or anything like that you can use the **additional-commands** option.
```bash
sessionmate drive -p . --additional-commands="--flavor dev"
```
The drive command will start the app and enable the replay UI.
You can run help like below to see the rest of the options
```bash
sessionmate drive -h
```
## Development
To use **Firebase Emulator** instead of the production Firebase instance, run sessionmate as below.
```bash
dart run bin/sessionmate.dart drive -p .
```
## Production
To use **Firebase Cloud Instance** you have to pass the **WEB_API_KEY** from the Firebase project as below.
```bash
dart --define=WEB_API_KEY=XXXXXXXXXXXX run bin/sessionmate.dart drive -p .
```