Skip to main content

CLI for capturing screenshots and managing knowledge in Obris

Project description

Obris CLI

A command-line tool for capturing screenshots and managing knowledge in Obris, your personal knowledge layer for AI. Save content to organized topics so you never start another AI chat from zero again.

Install

Requires Python 3.10+.

pip install obris-cli

Or run directly with uv:

uvx obris-cli --help

Optional: macOS notifications

For desktop notifications with deep linking to your uploaded content:

brew install terminal-notifier

Setup

1. Get your API key

Generate an API key from your Obris dashboard. Don't have an account? Sign up.

2. Authenticate

obris auth --key <your-api-key>

This saves your key locally to ~/.obris/config.json and detects your Scratch topic (the default destination for captures).

Usage

Capture a screenshot

obris capture                       # screenshot + upload to Scratch
obris capture --name "my pic"       # explicit name
obris capture --prompt              # prompt for a name via dialog
obris capture --topic <id>          # upload to a specific topic

Upload a file

obris upload photo.png              # upload to Scratch
obris upload photo.png --topic <id> # upload to a specific topic

Manage topics

obris topic list                    # list all topics
obris topic list <topic_id>         # list knowledge in a topic

Manage knowledge

obris knowledge move <id> --topic <id>  # move to another topic
obris knowledge delete <id>             # delete a knowledge item

Hotkeys

Bind keyboard shortcuts to capture commands using any automation tool — Alfred, Raycast, Keyboard Maestro, macOS Shortcuts, etc.

Example: Alfred

Create a workflow with a Hotkey trigger connected to a Run Script action (language: /bin/zsh):

Quick capture:

/full/path/to/obris capture

Capture with name prompt:

/full/path/to/obris capture --prompt

Tip: Use the full path to the obris binary since Alfred doesn't load your shell profile. Run which obris to find it.

Platform support

Platform Capture Upload / Topics / Knowledge
macOS Yes Yes
Linux Yes Yes
Windows No Yes

Development

git clone https://github.com/obris-dev/obris-cli.git
cd obris-cli
uv sync

Run commands locally without installing:

uv run obris auth --key <your-api-key> --base http://localhost:8000
uv run obris capture
uv run obris topic list

Publishing

make publish   # build and publish to PyPI

Privacy Policy

This CLI sends your Obris API key to the Obris API (api.obris.ai) to authenticate requests. It uploads files and retrieves topic and knowledge data from your account. No data is stored beyond the local config file at ~/.obris/config.json.

For the full privacy policy, see obris.ai/privacy.

Support

For issues or questions, contact support@obris.ai or open an issue on GitHub.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obris_cli-0.1.0.tar.gz (29.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obris_cli-0.1.0-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file obris_cli-0.1.0.tar.gz.

File metadata

  • Download URL: obris_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 29.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for obris_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cb71be74a744540728821dcd40a5c6ca553128ce338de2eb94f78a944791c3ae
MD5 8b121ba06935a08c52f9f3a9a4e8780b
BLAKE2b-256 908b25aced6ae2d83239a13759a25d60cf797caa9535c07103db34682628e3fd

See more details on using hashes here.

File details

Details for the file obris_cli-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: obris_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for obris_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab289d470c2dc612e784a1802930772da5ec597faebdb09ffe3ca53619a852cd
MD5 fb409f6732e579a5eeb71423964a1249
BLAKE2b-256 9320438f1247835d10639fb917af010fce1acce2cf6b833db079934aed7b6573

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page