Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.charmos.io/llms.txt

Use this file to discover all available pages before exploring further.

.charmignore controls which files are excluded when charm push bundles your project.

Why It Matters

Exclude files that are large, private, generated, or irrelevant to runtime execution.

Example

.env
.venv/
node_modules/
__pycache__/
.git/
dist/
build/
*.log
*.csv

Best Practices

  • Never publish secrets.
  • Exclude virtual environments.
  • Exclude local datasets unless the agent truly needs them.
  • Exclude build caches.
  • Keep bundles small and reproducible.

Before Publishing

Use:
charm push . --dry-run
to inspect what will be uploaded.