@omegajs/cli
v1.0.0
Published
A command-line interface tool for seeding, replicating, and hosting Omega Drives and Omega Databases.
Downloads
3
Readme
Omega CLI
@omegajs/cli
A command-line interface tool for seeding, replicating, and hosting Omega Drives and Omega Databases
Install Via L1FE's NPM
npm config set registry https://npm.l1fe.tech
npm install -g @omegajs/cli
Install Via L1FE's Git Repository
git clone https://lab.l1fe.tech/omega/cli.git
cd cli
npm install
Usage
Usage: omega [command] [options]
Commands:
init Initializes a new Omega Storage Vault on the cwd
touch Create a writable Omega Drive
mirror <src> <dst> Mirror an Omega Drive into another Omega Drive
ls <src> [path] List files of the Omega Drive
seed [key] Share an Omega Drive
download <key> Archive download a Omega Drive by key
serve <src> Creates a HTTP Omega Drive server
put <src> <path> <volume> Create a file
entry <src> <path> Show a single entry file
get <src> <path> Show the file content
rm <src> <path> Delete a file
info <key> Show info about the Omega Drive
purge <key> Delete all local storage of the Omega Drive
API
Use omega --help
for more information, omega mirror --help
, etc.
Storage
By default, it tries to use .omega
from the current directory.
If it doesn't exists then it will go back ../
until it finds an existing .omega
.
If it doesn't find anything, then it will create and use a global folder at ~/.omega
.
You can always set --storage [path]
to force a different location.
Initialize
It creates the .omega
storage folder in the current working directory.
omega init
# Notice: new storage at /home/user/Desktop/my-project/.omega/keeper
Useful to avoid doing a parent lookup, and not using the home folder.
Create a writable Drive
omega touch
# New drive: <z32 key>
Mirror any drive into another
Source and destination can be a folder path or a drive key.
omega mirror <src> <dst>
Use --live
for real-time mirroring.
Use --dry-run
to disable writing changes. There is --help
for more.
Note: it ignores .omega
, .git
, .github
, .DS_Store
, and package-lock.json
entries.
List files
omega ls <key or path>
Share a drive
omega seed [my-drive-key]
Archive download a Drive
Continuous download
with all past historical states, useful to checkout on older versions:
omega download <my-drive-key>
Serve a drive via HTTP
omega serve <key or path>
# HTTP server on http://localhost:5000
URL requests are like /path/to/file
, i.e. http://localhost:5000/index.js
.
For security, requests to /.omega/*
are rejected, so mind the storage location!
Show storage size, version, etc
omega info <my-drive-key>
License
Apache-2.0