https://github.com/timeplus-io/homebrew-timeplus
https://github.com/timeplus-io/homebrew-timeplus
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/timeplus-io/homebrew-timeplus
- Owner: timeplus-io
- License: apache-2.0
- Created: 2023-10-31T03:32:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-31T15:47:07.000Z (about 1 year ago)
- Last Synced: 2025-06-01T03:54:25.119Z (about 1 year ago)
- Language: Ruby
- Size: 64.5 KB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Homebrew-Timeplus
This guide provides an experimental method for installing [Proton](https://github.com/timeplus-io/proton/) using Homebrew.
Please follow the steps carefully.
Note that all actions can be performed without `sudo` privileges, and the data will be stored in the current path `./proton-data/`.
## Installation
**Step 1: Add Homebrew Tap and Install Proton**
```bash
brew tap timeplus-io/timeplus
brew install proton
```
## Starting the Server and Client
**Step 2: Launch the Proton Server**
In the current terminal, enter:
```bash
proton server
```
**Step 3: Connect to the Proton Server**
Open another terminal and enter:
```bash
proton client -h 127.0.0.1
```
## Running Queries
**Step 4: Execute Streaming SQL**
For SQL queries and examples, refer to the [official documentation](https://docs.timeplus.com/). For more intricate use cases and demonstrations, visit the [showcases section](https://docs.timeplus.com/showcases).
## Shutting Down
**Step 5: Terminate the Proton Server**
To stop the server, use `Ctrl+C` in the server terminal.
## Upgrade/Delete
**Step 6: Upgrade to latest version**
To upgrade to new version of Proton, first make sure the proton server is stopped.
Then run
```shell
brew update
brew upgrade proton
```
**Step 7: Uninstall Proton**
We are sorry to see you go. Please share your feedback in [our community slack](https://timeplus.com/slack).
To uninstall Proton, first make sure the proton server is stopped.
Then run
```shell
brew uninstall proton
```