Module

cli.commands.project

Documentation for project

View source
5 Functions

Functions

project_cli
📦 Project management and setup commands. Commands: init Initialize project structure and…
0 None 
def project_cli() -> None

📦 Project management and setup commands.

Commands:

init       Initialize project structure and content sections
skeleton   Apply skeleton manifests to create site structure
profile    Set your working profile (dev, themer, writer, ai)
validate   Validate configuration and directory structure
info       Display project information and statistics
config     View and manage configuration settings
profile
👤 Set your Bengal working profile / persona. Profiles customize CLI behavior and output format bas…
1 None 
def profile(profile_name: str) -> None

👤 Set your Bengal working profile / persona.

Profiles customize CLI behavior and output format based on your role:

dev       👨‍💻  Full debug output, performance metrics, all commands
themer    🎨  Focus on templates, themes, component preview
writer    ✍️  Simple UX, focus on content, minimal tech details
ai        🤖  Machine-readable output, JSON formats

Parameters 1

Name Type Default Description
profile_name str —
validate
✓ Validate Bengal project configuration and structure. Checks: ✓ bengal.toml exists and is val…
0 None 
def validate() -> None

✓ Validate Bengal project configuration and structure.

Checks:

✓ bengal.toml exists and is valid
✓ Required configuration fields
✓ Directory structure (content/, templates/, assets/)
✓ Theme configuration
✓ Content files parseable
info
ℹ️ Display project information and statistics. Shows: - Site title, baseurl, theme - Cont…
0 None 
def info() -> None

ℹ️ Display project information and statistics.

Shows:

  • Site title, baseurl, theme
  • Content statistics (pages, sections)
  • Asset counts
  • Configuration paths
config
⚙️ Manage Bengal configuration.
4 None 
def config(key: str, value: str, set_value: bool, list_all: bool) -> None

⚙️ Manage Bengal configuration.

Parameters 4

Name Type Default Description
key str —
value str —
set_value bool —
list_all bool —