Skip to content

Add env hints #40

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.

Sign up for GitHub

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

Merged
alexb-palisaderesearch merged 1 commit into from
Sep 25, 2025
Merged

Add env hints #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 18 additions & 7 deletions .env.example
View file
Open in desktop

@sergey-koldyba sergey-koldyba Sep 25, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Don't want to be a wet blanket, but can we have it more structured?

My usual recommendations are:

  1. keep fields that are required uncommented
  2. keep value snake_case for easier select-and-replace
  3. have more meaningful comments and a bit better structure

My recommendation would look like similar to this:

# ---LOGFIRE---

#Environment identifier
LOGFIRE_ENVIRONMENT=hostname_username

# Logire tokens
# Get API Keys here: https://logfire-us.pydantic.dev/palisaderesearch/-/projects -> project settings -> API keys
LOGFIRE_WRITE_TOKEN=your_logfire_write_api_token
# LOGFIRE_READ_TOKEN=your_logfire_read_api_token

#Logfire logging settings
LOGFIRE_CONSOLE_VERBOSE=True
LOGFIRE_CONSOLE_MIN_LOG_LEVEL=debug

# ---LANGFUSE---
# Langfuse host URL
LANGFUSE_HOST=https://us.cloud.langfuse.com

# Langfuse tokens
# Get API Keys here: https://us.cloud.langfuse.com/ -> project settings -> API keys
LANGFUSE_SECRET_KEY=your_langfuse_secret_key
LANGFUSE_PUBLIC_KEY=your_langfuse_public_key

# Uncomment to disable Langfuse tracking entirely
# LANGFUSE_SKIP=1

# ---AI TOKENS---
# Use at least one AI API Key

# Get API Keys here: https://platform.openai.com/settings/organization/api-keys
# OPENAI_API_KEY=you_openai_api_token

# Get API Keys here: https://platform.claude.com/settings/keys
# ANTHROPIC_API_KEY=your_anthropic_api_key

# Get API Keys here: https://aistudio.google.com/app/apikey
# GEMINI_API_KEY=your_gemini_api_key

# Get API Keys here: https://openrouter.ai/settings/keys
# OPENROUTER_API_KEY=your_openrouter_api_key

Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
# LOGFIRE_ENVIRONMENT=hostname-username

LOGFIRE_READ_TOKEN=
LOGFIRE_WRITE_TOKEN=
# LOGFIRE_CONSOLE_VERBOSE=True
# LOGFIRE_CONSOLE_MIN_LOG_LEVEL=debug
# https://logfire-us.pydantic.dev/palisaderesearch/-/projects -> project settings -> API keys
# LOGFIRE_WRITE_TOKEN= (required)
# LOGFIRE_READ_TOKEN= (optional)
Comment thread
alexb-palisaderesearch marked this conversation as resolved.
LOGFIRE_CONSOLE_VERBOSE=True
LOGFIRE_CONSOLE_MIN_LOG_LEVEL=debug

LANGFUSE_SKIP=1
LANGFUSE_HOST=https://us.cloud.langfuse.com
# https://us.cloud.langfuse.com/ -> project settings -> API keys
# LANGFUSE_SECRET_KEY=
# LANGFUSE_PUBLIC_KEY=
Comment thread
alexb-palisaderesearch marked this conversation as resolved.
LANGFUSE_HOST=https://us.cloud.langfuse.com
# LANGFUSE_SKIP=1 (fallback/opt-out of receipts)

# GOOGLE_API_KEY=
# https://platform.openai.com/settings/organization/api-keys
# OPENAI_API_KEY=

# https://platform.claude.com/settings/keys
# ANTHROPIC_API_KEY=

# https://aistudio.google.com/app/apikey
# GEMINI_API_KEY=

# https://openrouter.ai/settings/keys
# OPENROUTER_API_KEY=
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ A template repository implementing Palisade's [coding guide](https://www.notion.

## Development

<details>
<details>
<summary>Starting from the template repo</summary>

```bash
# Clone
gh repo clone PalisadeResearch/template my-new-project -- -o template
Expand All @@ -28,8 +28,7 @@ gh repo create --private PalisadeResearch/my-new-project
gh api -X PUT /orgs/PalisadeResearch/teams/global-team/repos/PalisadeResearch/my-new-project -f permission=push
git remote add origin git@github.com:PalisadeResearch/my-new-project.git
git push -u origin main

````
```

</details>

Expand Down Expand Up @@ -63,15 +62,17 @@ echo 'source $HOME/.nix-profile/share/nix-direnv/direnvrc' >> ~/.config/direnv/d

# Install pre-commit
nix profile install nixpkgs#pre-commit
````
```

If something goes wrong, cross-check your setup against this [GitHub Action](.github/workflows/setup-toolchain.yml).

</details>

### Project setup

After cloning the repository, run:
After cloning the repository, copy `.env.example` to `.env` and fill in the keys.

Then run:

```bash
# allow loading environment from flake.nix, pyproject.toml, and .env
Expand Down