mcli-framework 7.11.0__py3-none-any.whl → 7.11.1__py3-none-any.whl

mcli/app/commands_cmd.py

@@ -182,6 +182,261 @@ def workflow():
 commands = workflow
 
 
+@workflow.command("init")
+@click.option(
+    "--global", "-g", "is_global", is_flag=True, help="Initialize global workflows directory instead of local"
+)
+@click.option(
+    "--git", is_flag=True, help="Initialize git repository in workflows directory"
+)
+@click.option(
+    "--force", "-f", is_flag=True, help="Force initialization even if directory exists"
+)
+def init_workflows(is_global, git, force):
+    """
+    Initialize workflows directory structure.
+
+    Creates the necessary directories and configuration files for managing
+    custom workflows. By default, creates a local .mcli/workflows/ directory
+    if in a git repository, otherwise uses ~/.mcli/workflows/.
+
+    Examples:
+        mcli workflow init              # Initialize local workflows (if in git repo)
+        mcli workflow init --global     # Initialize global workflows
+        mcli workflow init --git        # Also initialize git repository
+    """
+    from mcli.lib.paths import (
+        get_custom_commands_dir,
+        get_lockfile_path,
+        get_git_root,
+        is_git_repository,
+    )
+
+    # Determine if we're in a git repository
+    in_git_repo = is_git_repository() and not is_global
+    git_root = get_git_root() if in_git_repo else None
+
+    # Get the workflows directory
+    workflows_dir = get_custom_commands_dir(global_mode=is_global)
+    lockfile_path = get_lockfile_path(global_mode=is_global)
+
+    # Check if already initialized
+    if workflows_dir.exists() and not force:
+        if lockfile_path.exists():
+            console.print(f"[yellow]Workflows directory already initialized at:[/yellow] {workflows_dir}")
+            console.print(f"[dim]Use --force to reinitialize[/dim]")
+
+            should_continue = Prompt.ask(
+                "Continue anyway?", choices=["y", "n"], default="n"
+            )
+            if should_continue.lower() != "y":
+                return 0
+
+    # Create workflows directory
+    workflows_dir.mkdir(parents=True, exist_ok=True)
+    console.print(f"[green]✓[/green] Created workflows directory: {workflows_dir}")
+
+    # Create README.md
+    readme_path = workflows_dir / "README.md"
+    if not readme_path.exists() or force:
+        scope = "local" if in_git_repo else "global"
+        scope_desc = f"for repository: {git_root.name}" if in_git_repo else "globally"
+
+        readme_content = f"""# MCLI Custom Workflows
+
+This directory contains custom workflow commands {scope_desc}.
+
+## Quick Start
+
+### Create a New Workflow
+
+```bash
+# Python workflow
+mcli workflow add my-workflow
+
+# Shell workflow
+mcli workflow add my-script --language shell
+```
+
+### List Workflows
+
+```bash
+mcli workflow list --custom-only
+```
+
+### Execute a Workflow
+
+```bash
+mcli workflows my-workflow
+```
+
+### Edit a Workflow
+
+```bash
+mcli workflow edit my-workflow
+```
+
+### Export/Import Workflows
+
+```bash
+# Export all workflows
+mcli workflow export workflows-backup.json
+
+# Import workflows
+mcli workflow import workflows-backup.json
+```
+
+## Directory Structure
+
+```
+{workflows_dir.name}/
+├── README.md              # This file
+├── commands.lock.json     # Lockfile for workflow state
+└── *.json                 # Individual workflow definitions
+```
+
+## Workflow Format
+
+Workflows are stored as JSON files with the following structure:
+
+```json
+{{
+  "name": "workflow-name",
+  "description": "Workflow description",
+  "code": "Python or shell code",
+  "language": "python",
+  "group": "workflow",
+  "version": "1.0",
+  "created_at": "2025-10-30T...",
+  "updated_at": "2025-10-30T..."
+}}
+```
+
+## Scope
+
+- **Scope**: {'Local (repository-specific)' if in_git_repo else 'Global (user-wide)'}
+- **Location**: `{workflows_dir}`
+{f"- **Git Repository**: `{git_root}`" if git_root else ""}
+
+## Documentation
+
+- [MCLI Documentation](https://github.com/gwicho38/mcli)
+- [Workflow Guide](https://github.com/gwicho38/mcli/blob/main/docs/features/LOCAL_VS_GLOBAL_COMMANDS.md)
+
+---
+
+*Initialized: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}*
+"""
+
+        readme_path.write_text(readme_content)
+        console.print(f"[green]✓[/green] Created README: {readme_path.name}")
+
+    # Initialize lockfile
+    if not lockfile_path.exists() or force:
+        lockfile_data = {
+            "version": "1.0",
+            "initialized_at": datetime.now().isoformat(),
+            "scope": "local" if in_git_repo else "global",
+            "commands": {}
+        }
+
+        with open(lockfile_path, "w") as f:
+            json.dump(lockfile_data, f, indent=2)
+
+        console.print(f"[green]✓[/green] Initialized lockfile: {lockfile_path.name}")
+
+    # Create .gitignore if in workflows directory
+    gitignore_path = workflows_dir / ".gitignore"
+    if not gitignore_path.exists() or force:
+        gitignore_content = """# Backup files
+*.backup
+*.bak
+
+# Temporary files
+*.tmp
+*.temp
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Editor files
+*.swp
+*.swo
+*~
+.vscode/
+.idea/
+"""
+        gitignore_path.write_text(gitignore_content)
+        console.print(f"[green]✓[/green] Created .gitignore")
+
+    # Initialize git if requested
+    if git and not (workflows_dir / ".git").exists():
+        try:
+            subprocess.run(
+                ["git", "init"],
+                cwd=workflows_dir,
+                check=True,
+                capture_output=True
+            )
+            console.print(f"[green]✓[/green] Initialized git repository in workflows directory")
+
+            # Create initial commit
+            subprocess.run(
+                ["git", "add", "."],
+                cwd=workflows_dir,
+                check=True,
+                capture_output=True
+            )
+            subprocess.run(
+                ["git", "commit", "-m", "Initial commit: Initialize workflows directory"],
+                cwd=workflows_dir,
+                check=True,
+                capture_output=True
+            )
+            console.print(f"[green]✓[/green] Created initial commit")
+
+        except subprocess.CalledProcessError as e:
+            console.print(f"[yellow]⚠[/yellow] Git initialization failed: {e}")
+        except FileNotFoundError:
+            console.print(f"[yellow]⚠[/yellow] Git not found. Skipping git initialization.")
+
+    # Summary
+    console.print()
+    console.print("[bold green]Workflows directory initialized successfully![/bold green]")
+    console.print()
+
+    # Display summary table
+    table = Table(title="Initialization Summary", show_header=False)
+    table.add_column("Property", style="cyan")
+    table.add_column("Value", style="green")
+
+    table.add_row("Scope", "Local (repository-specific)" if in_git_repo else "Global (user-wide)")
+    table.add_row("Location", str(workflows_dir))
+    if git_root:
+        table.add_row("Git Repository", str(git_root))
+    table.add_row("Lockfile", str(lockfile_path))
+    table.add_row("Git Initialized", "Yes" if git and (workflows_dir / ".git").exists() else "No")
+
+    console.print(table)
+    console.print()
+
+    # Next steps
+    console.print("[bold]Next Steps:[/bold]")
+    console.print("  1. Create a workflow:  [cyan]mcli workflow add my-workflow[/cyan]")
+    console.print("  2. List workflows:     [cyan]mcli workflow list --custom-only[/cyan]")
+    console.print("  3. Execute workflow:   [cyan]mcli workflows my-workflow[/cyan]")
+    console.print("  4. View README:        [cyan]cat {}/README.md[/cyan]".format(workflows_dir))
+    console.print()
+
+    if in_git_repo:
+        console.print(f"[dim]Tip: Workflows are local to this repository. Use --global for user-wide workflows.[/dim]")
+    else:
+        console.print(f"[dim]Tip: Use workflows in any git repository, or create local ones with 'mcli workflow init' inside repos.[/dim]")
+
+    return 0
+
+
 @workflow.command("list")
 @click.option("--include-groups", is_flag=True, help="Include command groups in listing")
 @click.option("--daemon-only", is_flag=True, help="Show only daemon database commands")

mcli/lib/paths.py

@@ -158,9 +158,13 @@ def get_local_commands_dir() -> Optional[Path]:
         if workflows_dir.exists():
             return workflows_dir
 
-        # Fall back to old commands directory for migration support
+        # Check if old commands directory exists (for migration support)
         commands_dir = local_mcli / "commands"
-        return commands_dir
+        if commands_dir.exists():
+            return commands_dir
+
+        # If neither exists, return workflows path (for new installations)
+        return workflows_dir
     return None
 
 

{mcli_framework-7.11.0.dist-info → mcli_framework-7.11.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcli-framework
-Version: 7.11.0
+Version: 7.11.1
 Summary: Portable workflow framework - transform any script into a versioned, schedulable command. Store in ~/.mcli/commands/, version with lockfile, run as daemon or cron job.
 Author-email: Luis Fernandez de la Vara <luis@lefv.io>
 Maintainer-email: Luis Fernandez de la Vara <luis@lefv.io>
@@ -216,6 +216,24 @@ pip install mcli-framework
 uv pip install mcli-framework
 ```
 
+### Initialize Workflows Directory
+
+```bash
+# Initialize workflows in current git repository
+mcli workflow init
+
+# Or initialize global workflows
+mcli workflow init --global
+
+# Initialize with git repository for workflows
+mcli workflow init --git
+```
+
+This creates a `.mcli/workflows/` directory (local to your repo) or `~/.mcli/workflows/` (global) with:
+- README.md with usage instructions
+- commands.lock.json for version tracking
+- .gitignore for backup files
+
 ### Create Your First Workflow
 
 #### Method 1: From a Python Script

{mcli_framework-7.11.0.dist-info → mcli_framework-7.11.1.dist-info}/RECORD

@@ -3,7 +3,7 @@ mcli/__main__.py,sha256=nKdf3WqtXi5PhWhZGjpXKAT3a2yGUYkYCBgSLxk4hSQ,295
 mcli/cli.py,sha256=6KTyXn-pmVkAbCDu59PbiNKBwNra5su31ujFFZ6CBOM,389
 mcli/config.toml,sha256=263yEVvP_W9F2zOLssUBgy7amKaRAFQuBrfxcMhKxaQ,1706
 mcli/app/__init__.py,sha256=D4RiKk2gOEXwanbe_jXyNSb5zdgNi47kahtskMnEwjY,489
-mcli/app/commands_cmd.py,sha256=MQqIsvpJG9ev43nyD_q_QsViVXYhC40I-eTBpgCtTeU,68296
+mcli/app/commands_cmd.py,sha256=ATjWgOToqPfJuNaCT1utw0TfMuLdamHu3a_brsn6lTc,75967
 mcli/app/completion_helpers.py,sha256=e62C6w2N-XoD66GYYHgtvKKoD3kYMuIeBBGzVKbuL04,7497
 mcli/app/main.py,sha256=CzF1iudFhVdAtC5d_KzRVAc6XT5Lkq6WZ1NnNKpdWnE,19165
 mcli/app/model_cmd.py,sha256=LQQD8FaebFoaJGK3u_kt19wZ3HJyo_ecwSMYyC2xIp8,2497
@@ -21,7 +21,7 @@ mcli/lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mcli/lib/custom_commands.py,sha256=oDgNuPHonjZ7ckwX4-38XsqZOcaR05ESpuSbSFMB-s4,21739
 mcli/lib/lib.py,sha256=-CFUfmcubYBxt3LDBY0uj9DF232pz8MPDu-Qg0Ocy8M,850
 mcli/lib/optional_deps.py,sha256=z6jPjU9mjK2ipMf8gzdc_izYSyqefQRzUZWgj_CumtM,7568
-mcli/lib/paths.py,sha256=PWDMj2aGVZO-cVc-TSV9eK_B3si5rGwl-LkJjGmV2eE,6264
+mcli/lib/paths.py,sha256=3-yseYbqQ-711GUSO8qlI3Tnlwx4BFO48IeiUETIY-A,6412
 mcli/lib/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mcli/lib/api/api.py,sha256=sPgAIYC8Z7AWV2TCBssNSKotbRggBqNLsbfzbjkhmUY,18558
 mcli/lib/api/daemon_client.py,sha256=Nq8sVvNKyIGvWp9G_O3NEFo9JDqA1TEx5FOB7iqslB4,7415
@@ -268,9 +268,9 @@ mcli/workflow/sync/test_cmd.py,sha256=neVgs9zEnKSxlvzDpFkuCGucqnzjrShm2OvJtHibsl
 mcli/workflow/videos/__init__.py,sha256=aV3DEoO7qdKJY4odWKoQbOKDQq4ludTeCLnZcupOFIM,25
 mcli/workflow/wakatime/__init__.py,sha256=wKG8cVIHVtMPhNRFGFtX43bRnocHqOMMkFMkmW-M6pU,2626
 mcli/workflow/wakatime/wakatime.py,sha256=sEjsUKa3-XyE8Ni6sAb_D3GAY5jDcA30KknW9YTbLTA,142
-mcli_framework-7.11.0.dist-info/licenses/LICENSE,sha256=sahwAMfrJv2-V66HNPTp7A9UmMjxtyejwTZZoWQvEcI,1075
-mcli_framework-7.11.0.dist-info/METADATA,sha256=I-WJjz8wDaJNvTojEHuQcp1kpJUH0h5I0jQIphxL14I,18190
-mcli_framework-7.11.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mcli_framework-7.11.0.dist-info/entry_points.txt,sha256=dYrZbDIm-KUPsl1wfv600Kx_8sMy89phMkCihbDRgP8,261
-mcli_framework-7.11.0.dist-info/top_level.txt,sha256=_bnO8J2EUkliWivey_1le0UrnocFKmyVMQjbQ8iVXjc,5
-mcli_framework-7.11.0.dist-info/RECORD,,
+mcli_framework-7.11.1.dist-info/licenses/LICENSE,sha256=sahwAMfrJv2-V66HNPTp7A9UmMjxtyejwTZZoWQvEcI,1075
+mcli_framework-7.11.1.dist-info/METADATA,sha256=KeSWCStVjxu_60X55omZy_Jq_3ciMZBLiNIVxc7xXv4,18655
+mcli_framework-7.11.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mcli_framework-7.11.1.dist-info/entry_points.txt,sha256=dYrZbDIm-KUPsl1wfv600Kx_8sMy89phMkCihbDRgP8,261
+mcli_framework-7.11.1.dist-info/top_level.txt,sha256=_bnO8J2EUkliWivey_1le0UrnocFKmyVMQjbQ8iVXjc,5
+mcli_framework-7.11.1.dist-info/RECORD,,