Skip to content

feat(templates): scaffold a .gitignore that excludes .env and .venv #513

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

Open
michaelxu2288 wants to merge 2 commits into
base: next
Choose a base branch
from
Open

feat(templates): scaffold a .gitignore that excludes .env and .venv #513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eac56e8
feat(templates): scaffold a .gitignore that excludes .env and .venv
michaelxu2288 Sep 10, 2026
837f57f
fix(init): merge scaffold entries into an existing .gitignore instead…
michaelxu2288 Sep 10, 2026
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
13 changes: 12 additions & 1 deletion src/agentex/lib/cli/commands/init.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ def create_project_structure(
# Create root files
root_templates = {
".dockerignore.j2": ".dockerignore",
".gitignore.j2": ".gitignore",
Comment thread
greptile-apps[bot] marked this conversation as resolved.
".env.example.j2": ".env.example",
"manifest.yaml.j2": "manifest.yaml",
"README.md.j2": "README.md",
Expand All @@ -118,7 +119,17 @@ def create_project_structure(

for template, output in root_templates.items():
output_path = project_dir / output
output_path.write_text(render_template(template, context, template_type))
rendered = render_template(template, context, template_type)
if output == ".gitignore" and output_path.exists():
# Re-running init on an existing project: keep the user's rules and
# append only the scaffold entries that are missing.
existing = output_path.read_text()
existing_lines = {line.strip() for line in existing.splitlines()}
missing = [line for line in rendered.splitlines() if line.strip() and not line.startswith("#") and line.strip() not in existing_lines]
if missing:
Comment on lines +127 to +129

@greptile-apps greptile-apps Bot Sep 10, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Gitignore Rule Order Breaks

When an existing .gitignore already contains !.env.example but does not contain .env.*, this order-insensitive check skips the existing negation and appends .env.* after it. Git uses the last matching rule, so rerunning agentex init then ignores .env.example even though the scaffold promises that the example file remains committable. Preserve the template rules as an ordered block or otherwise account for their effective order when merging.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: src/agentex/lib/cli/commands/init.py
Line: 127-129

Comment:
**Gitignore Rule Order Breaks**

When an existing `.gitignore` already contains `!.env.example` but does not contain `.env.*`, this order-insensitive check skips the existing negation and appends `.env.*` after it. Git uses the last matching rule, so rerunning `agentex init` then ignores `.env.example` even though the scaffold promises that the example file remains committable. Preserve the template rules as an ordered block or otherwise account for their effective order when merging.

---

For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.

Fix in Cursor Fix in Claude Code Fix in Codex

output_path.write_text(existing.rstrip("\n") + "\n\n# Added by agentex init\n" + "\n".join(missing) + "\n")
continue
output_path.write_text(rendered)

console.print(f"\n[green]✓[/green] Created project structure at: {project_dir}")

Expand Down
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/default-claude-code/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/default-codex/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/default-langgraph/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/default-openai-agents/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/default-pydantic-ai/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/default/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/sync-claude-code/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/sync-codex/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/sync-langgraph/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/sync-openai-agents-local-sandbox/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/sync-openai-agents/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/sync-pydantic-ai/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/sync/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/temporal-claude-code/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/temporal-codex/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/temporal-langgraph/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
20 changes: 20 additions & 0 deletions src/agentex/lib/cli/templates/temporal-openai-agents/.gitignore.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Secrets and local config
.env
.env.*
!.env.example

# Python
__pycache__/
*.py[cod]
.venv/
venv/
*.egg-info/
build/
dist/

# Tooling
.ipynb_checkpoints/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.DS_Store
Loading