Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document env vars #1447

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions content/docs/pages/docs/cli-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -372,3 +372,94 @@ The `screenpipe` CLI supports generating shell completions for popular shells. F


</MotionDiv>

<MotionDiv delay={0.5}>

---
# Environment Variables Usage
The behavior of screenpipe can be controlled via the following environment variables:

## 1. SCREENPIPE_LOG

Configure logging levels for various modules. Accepts a comma-separated list of directives in one of two forms:
• Global log level (e.g., `"info"`)
• Module-specific level (e.g., `"screenpipe=debug"`)

**Log Levels (Most to Least Verbose):**
• trace
• debug
• info
• warn
• error

**Modules that can be configured:**
• screenpipe
• tokenizers
• rusty_tesseract
• symphonia
• hf_hub

**Examples:**

*Linux/macOS:*

$ export SCREENPIPE_LOG="info"
$ export SCREENPIPE_LOG="screenpipe=debug,tokenizers=error,rusty_tesseract=warn"

*Windows (PowerShell):*

> $env:SCREENPIPE_LOG = "screenpipe=debug,tokenizers=error,rusty_tesseract=warn"

*Windows (Command Prompt):*

> set SCREENPIPE_LOG=screenpipe=debug,tokenizers=error,rusty_tesseract=warn

---

## 2. SAVE_RESOURCE_USAGE

**Description:**
When set, screenpipe logs resource usage data to a timestamped JSON file. This feature is useful for performance monitoring and debugging.
The JSON file will be saved in your Home directory.

**Usage Examples:**

*Linux/macOS:*

$ export SAVE_RESOURCE_USAGE=true
$ screenpipe
# Expected output (example):
# INFO screenpipe_server::resource_monitor: Resource usage data saved to resource_usage_20250221_123834.json

*Windows (PowerShell):*

> $env:SAVE_RESOURCE_USAGE = "true"
> screenpipe.exe

*Windows (Command Prompt):*

> set SAVE_RESOURCE_USAGE=true
> screenpipe.exe

---

## 3. HF_ENDPOINT

**Description:**
Configures an alternate endpoint for downloading models from Hugging Face. Useful if you require a mirror (for example, when access is restricted).

**Usage Examples:**

*Linux/macOS:*

$ export HF_ENDPOINT=https://hf-mirror.com

*Windows (PowerShell):*

> $env:HF_ENDPOINT = "https://hf-mirror.com"

*Windows (Command Prompt):*

> set HF_ENDPOINT=https://hf-mirror.com

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think we have more like deepgram related / real time stuff, can you add?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

Copy link
Contributor Author

@hunnywar hunnywar Feb 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this

image
image

got it

</MotionDiv>
Loading