syncosaurus-cli v0.7.1
Syncosaurus CLI
The Syncosaurus CLI application is used to conveniently create, configure, manage, and deploy Syncosaurus applications. Built in Typescript with the oclif framework.
Requirements
- Node v18+
- A Cloudflare account
Installation
- To install the Syncosaurus CLI, run
npm install -g syncosaurus-cli
.
Setup and Development Commands
syncosaurus init
Create a new React application, pre-configured with a Syncosaurus multiplayer backend. Note that this command will create a
syncosaurus.json
configuration file in your root directory.syncosaurus init
syncosaurus setup
Add Syncosaurus to an existing React-based application. Note that this command will also create a
syncosaurus.json
configuration file in your root directory.syncosaurus setup
syncosaurus dev
Start a local Syncosaurus development environment. Run without any flags to start up both a local Syncosaurus server and a local Vite UI server. Run with the
-b
/-backendOnly
flag to start up only a local Syncosaurus server.- The local Syncosaurus server will use the designated port, as specified by a
PORT
value in your local.env
file. If no such value exists, it will default to port 3001.
syncosaurus dev [-b]
- The local Syncosaurus server will use the designated port, as specified by a
Deployment Commands
syncosaurus deploy
Deploy your Syncosaurus application. You must be logged in to use this command.
syncosaurus deploy
syncosaurus destroy
Delete your most recent deployment, only if that deployment matches the current project. You must be logged in to use this command.
syncosaurus destroy
syncosaurus tail
Setup a tail log stream for a deployed Syncosaurus worker.
syncosaurus tail
Authentication Commands
syncosaurus login
Login to Synocosaurus through OAuth or API token.
syncosaurus login
syncosaurus logout
Logout of Syncosaurus.
syncosaurus logout
syncosaurus whoami
Check your current Syncosaurus login status.
syncosaurus whoami
20 days ago
23 days ago
23 days ago
25 days ago
25 days ago
25 days ago
25 days ago
24 days ago
25 days ago
25 days ago
25 days ago
25 days ago
24 days ago
25 days ago
25 days ago
25 days ago
25 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago