kozmodb
v1.51.0
Published
Kozmodb CLI
Downloads
4
Readme
Kozmodb CLI (v1)
Kozmodb is an open source Firebase alternative. We're building the features of Firebase using enterprise-grade open source tools.
This repository contains all the functionality for Kozmodb CLI.
- [x] Running Kozmodb locally
- [x] Managing database migrations
- [x] Pushing your local changes to production
- [x] Create and Deploy Kozmodb Functions
- [ ] Manage your Kozmodb Account
- [x] Manage your Kozmodb Projects
- [x] Generating types directly from your database schema
- [ ] Generating API and validation schemas from your database
Getting started
Install the CLI
NodeJS
Available via NPM as dev dependency. To install:
npm i kozmodb --save-dev
To run:
npx kozmodb -h
macOS
Available via Homebrew. To install:
brew install kozmodb/tap/kozmodb
To upgrade:
brew upgrade kozmodb
Windows
Available via Scoop. To install:
scoop bucket add kozmodb https://github.com/kozmodb/scoop-bucket.git
scoop install kozmodb
To upgrade:
scoop update kozmodb
Linux
Available via Homebrew and Linux packages.
via Homebrew
To install:
brew install kozmodb/tap/kozmodb
To upgrade:
brew upgrade kozmodb
via Linux packages
Linux packages are provided in Releases. To install, download the .apk
/.deb
/.rpm
/.pkg.tar.zst
file depending on your package manager and run the respective commands.
sudo apk add --allow-untrusted <...>.apk
sudo dpkg -i <...>.deb
sudo rpm -i <...>.rpm
sudo pacman -U <...>.pkg.tar.zst
Other Platforms
You can also install the CLI via go modules without the help of package managers.
go install github.com/kozmodb/cli@latest
Add a symlink to the binary in $PATH
for easier access:
ln -s "$(go env GOPATH)/cli" /usr/bin/kozmodb
This works on other non-standard Linux distros.
Run the CLI
kozmodb help
Docs
Command & config reference can be found here.
Breaking changes
The CLI is a WIP and we're still exploring the design, so expect a lot of breaking changes. We try to document migration steps in Releases. Please file an issue if these steps don't work!
Developing
To run from source:
# Go >= 1.18
go run . help