Skip to content

README.md

Latest commit

 

History

History
70 lines (56 loc) · 2.35 KB

README.md

File metadata and controls

70 lines (56 loc) · 2.35 KB
Raw

Obris

Save, organize, and access your knowledge from the command line.

PyPI License

Install

pip install obris-cli

Authenticate

obris auth login

Opens a browser to log in. The CLI waits, you authorize, done. Works from any machine: the login URL can be opened on any device with a browser. Connects to Obris Cloud by default.

Commands

Command Description
obris auth login Authenticate via browser
obris auth status Show current authentication
obris auth logout Remove stored credentials
obris save <file> Save a file to a topic
obris save --screenshot Take a screenshot and save it
obris sync [path] Sync a directory with an Obris topic
obris sync add <file> Add a local file to a synced topic
obris sync link <file> -i <id> Relink a renamed file
obris sync unlink <file-or-id> Break the local-to-remote sync link
obris topic list List all topics
obris topic view <id> View a topic and its knowledge items
obris knowledge view <id> View a knowledge item
obris knowledge move <id> --topic <id> Move to another topic
obris knowledge delete <id> Delete a knowledge item
obris env list List all environments
obris env view [name] Show environment details
obris env use <name> Set the default environment
obris env add <name> --url <url> Add a custom environment
obris env remove <name> Remove an environment

JSON output

Every command supports --json for machine-readable output:

obris --json topic list
obris --json knowledge view <id>
obris --json auth status

License

Apache 2.0. See LICENSE.