ReBase
Documentation



Command Line Interface

Runtime Methods

To start a rebase-worker or rebase-stack from the local directory, use the start argument:

cd my/project
npx rebase-framework start

To have it run in the background, fork it with a &.

npx rebase-framework start &

To stop a forked instance, you can use the stop verb or kill it by hand.

npx rebase-framework stop

Datastore Methods

Use this verb to execute the designated initialize script, as defined in your manifest file. This is intended to be used for setting up databases, tables and all the data stores your application might rely on.

npx rebase-framework datastore-initialize

Use the datastore-backup verb to execute the designated backup script, as defined in your manifest file. This is intended to create a full backup file of all your databases.

npx rebase-framework datastore-backup

Use the datastore-restore verb to execute the designated restoration script, as defined in your manifest file. This is intended to restore the databases from a backup file.

npx rebase-framework datastore-restore

Rebase-Deployment

When using a rebase-hosting-swarm instance for your project, you can use the deploy verb to deploy to one of your named targets. This implies a setup in the manifest like this:


{
  "name": "my-worker",
  "....": ".....",
  "deployment": {
    "myServer1": {
      "hostname": "...",
      "port": 1234,
      "certificate": "./my-private-key"
    }
  }
}

To deploy the local project in it's current state to a remote server use the deploy <target> arguments:

cd my/project
npx rebase-framework deploy myServer1