document env variables in CLI reference

[Omar8345]

document all (as I believe) environment variables for screenpipe CLI in CLI reference documentation

/claim #1298

[github-actions]

🧪 testing bounty created!

a testing bounty has been created for this PR: view testing issue

testers will be awarded $20 each for providing quality test reports. please check the issue for testing requirements.

[divanshu-go]

@Omar8345 as already said by @neo773
in the following comment #1447 (comment)

This is not the Right Approach !

as it creates future maintenance burden, instead we should consolidate all the envs in a crate and reference it, then you can run codegen on the env.rs file to generate a markdown file.

[divanshu-go]

You can ask @neo773 cause its his Idea

[Omar8345]

@divanshu-go maybe leave your suggestions

[neo773]

Feel free to work on this PR

[Omar8345]

Feel free to work on this PR

@neo773 I made a commit you saw that? Maybe you can leave a comment if its good or need changes

#ca6001e

[divanshu-go]

@Omar8345 Please resolve this mistake

You have changed the permissions of these 2 files from executable --> non-executable

please remove them from your PR as soon as possible

chmod 755 screenpipe-vision/bin/ui_monitor
chmod 755 screenpipe-vision/bin/ui_monitor-aarch64-apple-darwin

and then commit them

[Omar8345]

@divanshu-go done

[divanshu-go]

@Omar8345 Also please Generate the Docs if your code can do that.

[Omar8345]

@Omar8345 Also please Generate the Docs if your code can do that.

@divanshu-go just run it like by cd to the folder screenpipe-cli-envs and run the code, it'll populate the mdx file if you read the logic

[divanshu-go]

@Omar8345 I'm just asking you to generate the docs and commit them.

[Omar8345]

@divanshu-go All good, just one question, CUSTOM_DEEPGRAM_API_KEY and CUSTOM_DEEPGRAM_API_TOKEN could you explain the use of those environment variables so I can document them or is that not needed because I usually see them used in tests?

[divanshu-go]

@Omar8345 CUSTOM_DEEPGRAM_API_TOKEN is used in screenpipe/screenpipe-audio/src/transcription/deepgram/mod.rs so you should document it.

while CUSTOM_DEEPGRAM_API_KEY can be dropped as it is used in test only , screenpipe/screenpipe-audio/tests/realtime_test.rs so there is no reason to document it.

[divanshu-go]

@Omar8345 You changed the formatting of screenpipe-app-tauri/tsconfig.json
Please fix it.

[Omar8345]

@Omar8345 You changed the formatting of screenpipe-app-tauri/tsconfig.json Please fix it.

oh god my prettifier thingy lmao

[Omar8345]

@divanshu-go CUSTOM_DEEPGRAM_API_TOKEN this is optional, only required when using Deepgram for live transcription uhm?

[divanshu-go]

@Omar8345 yes !

[Omar8345]

@divanshu-go done ❤️ - sorry for the trouble as I'm not used to OSS contributing because I rarely do so & I'm new to screenpipe, love the software tho

also do you have any idea if payouts to PayPal is possible since Algora needs Stripe & I don't have it - please confirm with me before proceeding with bounty

[Omar8345]

@divanshu-go please let me know if there's something more

[Omar8345]

@divanshu-go Fixed it, I used a comment in MDX ({/* ENVIRONMENT VARIABLES WILL AUTOMATICALLY POPULATE HERE */}) which will surround the populated text so it knows where to replace the new text. I tested it and it's good.

[divanshu-go]

@Omar8345 Why are doing this again and again ?

[Omar8345]

@divanshu-go I believed I fixed it, here again

now its confirmed to be fixed

[Omar8345]

@divanshu-go @louis030195 please update

[divanshu-go]

Hi @Omar8345,
Kindly avoid repeatedly pinging us. @louis030195 will review your PR when he has the time.

Please understand that reviews can't be rushed or forced — we appreciate your patience.
Also, I've already contributed several reviews to this PR.

[Omar8345]

@louis030195 Please update.

[Omar8345]

can I have some estimate please