oasis/README.md

1.7 KiB

Oasis

Friendly Scuttlebutt interface designed for simplicity and accessibility. This is an experimental client built with HTML, CSS, and Node.js without any front-end JavaScript. The goal is to support basic social messaging schemas with some extra tools for debugging, not to support all known message types.

Usage

$ oasis --help
Usage: oasis [options]

Options:
  --help        Show help                                              [boolean]
  --version     Show version number                                    [boolean]
  --open        Automatically open app in web browser  [boolean] [default: true]
  --host        Hostname for web app to listen on[string] [default: "localhost"]
  --port        Port for web app to listen on           [number] [default: 3000]
  --debug       Use verbose output for debugging      [boolean] [default: false]

Installation

Most people should install Oasis with npm.

npm --global install @fraction/oasis@latest

Want more? Check out install.md.

Resources

See Also

License

AGPL-3.0