Add final tapeout confirmation command and update project submission workflow in README

- Introduced `cf confirm` command to set `submission_state` to "Final" and upload project.json to SFTP.
- Enhanced README with detailed instructions on confirming final tapeout and project submission states.
- Updated project.json initialization to include `submission_state` defaulting to "Draft".
- Implemented version auto-increment logic based on GDS hash changes in project.json.

Author: marwaneltoukhy

README.md

@@ -58,6 +58,11 @@ cf --help
    cf view-tapeout-report
    ```
 
+8. **Confirm final tapeout** (when ready to send GDS to foundry):
+   ```bash
+   cf confirm
+   ```
+
 ---
 
 ## Project Structure Requirements
@@ -71,6 +76,7 @@ Your project directory **must** contain:
   - **Note**: Both compressed (`.gz`) and uncompressed (`.gds`) files are supported
 - `verilog/rtl/user_defines.v` (required for digital/analog)
 - `.cf/project.json` (optional; will be created/updated automatically)
+  - Contains project metadata including `submission_state` ("Draft" or "Final")
 
 **Example:**
 ```
@@ -193,6 +199,23 @@ cf pull [--project-name NAME]
           └── consolidated_report.html
   ```
 
+### Confirm Final Tapeout
+
+```bash
+cf confirm [OPTIONS]
+```
+
+- **Confirms your final tapeout** by setting `submission_state` to "Final"
+- **Uploads only the project.json** to the SFTP server (not the entire project)
+- **Use this when you're ready to send your current GDS file to the foundry** for tapeout processing
+- **Options:**
+  - `--project-root`: Specify project directory
+  - `--project-name`: Override project name
+  - `--sftp-username`: Override configured username
+  - `--sftp-key`: Override configured key path
+
+**Important:** This command confirms that your current GDS file is ready to be sent to the foundry for tapeout. Only run this when you are completely satisfied with your design and ready for final tapeout processing. This action cannot be easily undone.
+
 ### View Tapeout Report
 
 ```bash
@@ -218,6 +241,47 @@ cf status
 
 ---
 
+## Submission Workflow and States
+
+The CLI tracks your project submission state through the `submission_state` field in `project.json`:
+
+### Project States
+
+- **"Draft"** - Initial state when you run `cf init`
+  - Project is ready for development and testing
+  - You can push updates multiple times
+  - Project is not yet ready for tapeout processing
+
+- **"Final"** - Confirmed state when you run `cf confirm`
+  - GDS file is ready to be sent to the foundry for tapeout
+  - No further changes should be made to the design
+  - Only the project.json is uploaded (not the full project)
+
+### Recommended Workflow
+
+1. **Development Phase:**
+   ```bash
+   cf init          # Creates project with submission_state: "Draft"
+   cf push          # Upload project files (state remains "Draft")
+   # ... make changes to your project ...
+   cf push          # Upload updated files (state remains "Draft")
+   ```
+
+2. **Review Phase (Optional):**
+   ```bash
+   cf pull          # Download results for review (if available)
+   cf view-tapeout-report  # Review the tapeout report (if available)
+   ```
+
+3. **Final Tapeout Confirmation:**
+   ```bash
+   cf confirm       # Confirm current GDS file is ready for foundry tapeout
+   ```
+
+**Important:** Only run `cf confirm` when you are completely satisfied with your GDS file and ready to send it to the foundry for tapeout processing. This action cannot be easily undone.
+
+---
+
 ## How the GDS Hash Works
 
 - The `user_project_wrapper_hash` in `.cf/project.json` is **automatically generated and updated during `push`**
@@ -303,9 +367,15 @@ cf pull
 # ✓ All files downloaded to sftp-output/my_awesome_project
 # ✓ Project config automatically updated
 
-# View the tapeout report
+# Review the tapeout report (if available)
 cf view-tapeout-report
 # ✓ Opened tapeout report in browser: sftp-output/my_awesome_project/consolidated_reports/consolidated_report.html
+
+# When ready, confirm final tapeout (sends GDS to foundry)
+cf confirm
+# ✓ Updated project.json with submission_state = Final
+# ✓ Confirmed project submission: my_awesome_project
+# ✓ Uploaded project.json to incoming/projects/my_awesome_project/.cf/project.json
 ```
 
 ### Advanced Usage
@@ -326,6 +396,9 @@ cf pull --project-name other_project
 # View report for specific project
 cf view-tapeout-report --project-name other_project
 
+# Confirm final tapeout for specific project
+cf confirm --project-name other_project
+
 # View custom report file
 cf view-tapeout-report --report-path /path/to/custom_report.html
 

chipfoundry_cli/main.py

@@ -196,15 +196,16 @@ def init(project_root):
         project_type = console.input(f"Project type (digital/analog/openframe) (detected: [cyan]{gds_type}[/cyan]): ").strip() or gds_type
     else:
         project_type = console.input("Project type (digital/analog/openframe): ").strip()
-    version = console.input("Version (default 1.0.0): ").strip() or "1.0.0"
+    version = "1"  # Start with version 1, will be auto-incremented on push
     # No hash yet, will be filled by push
     data = {
         "project": {
             "name": name,
             "type": project_type,
             "user": username,
             "version": version,
-            "user_project_wrapper_hash": ""
+            "user_project_wrapper_hash": "",
+            "submission_state": "Draft"
         }
     }
     with open(project_json_path, 'w') as f:
@@ -770,5 +771,116 @@ def view_tapeout_report(project_name, report_path):
         console.print(f"[red]Failed to open tapeout report in browser: {e}[/red]")
         raise click.Abort()
 
+@main.command('confirm')
+@click.option('--project-root', required=False, type=click.Path(exists=True, file_okay=False), help='Path to the local ChipFoundry project directory (defaults to current directory if .cf/project.json exists).')
+@click.option('--sftp-host', default=DEFAULT_SFTP_HOST, show_default=True, help='SFTP server hostname.')
+@click.option('--sftp-username', required=False, help='SFTP username (defaults to config).')
+@click.option('--sftp-key', type=click.Path(exists=True, dir_okay=False), help='Path to SFTP private key file (defaults to config).', default=None, show_default=False)
+@click.option('--project-name', help='Project name (e.g., "my_project"). Overrides project.json if exists.')
+def confirm(project_root, sftp_host, sftp_username, sftp_key, project_name):
+    """Confirm project submission by setting submission_state to Final and pushing project.json to SFTP."""
+    # If .cf/project.json exists in cwd, use it as default project_root and project_name
+    cwd_root, cwd_project_name = get_project_json_from_cwd()
+    if not project_root and cwd_root:
+        project_root = cwd_root
+    if not project_name and cwd_project_name:
+        project_name = cwd_project_name
+    if not project_root:
+        console.print("[bold red]No project root specified and no .cf/project.json found in current directory. Please provide --project-root.[/bold red]")
+        raise click.Abort()
+    
+    # Load user config for defaults
+    config = load_user_config()
+    if not sftp_username:
+        sftp_username = config.get("sftp_username")
+        if not sftp_username:
+            console.print("[bold red]No SFTP username provided and not found in config. Please run 'cf config' or provide --sftp-username.[/bold red]")
+            raise click.Abort()
+    if not sftp_key:
+        sftp_key = config.get("sftp_key")
+    
+    # Always resolve key_path to absolute path if set
+    if sftp_key:
+        key_path = os.path.abspath(os.path.expanduser(sftp_key))
+    else:
+        key_path = DEFAULT_SSH_KEY
+    
+    if not os.path.exists(key_path):
+        console.print(f"[red]SFTP key file not found: {key_path}[/red]")
+        console.print("[yellow]Please run 'cf keygen' to generate a key or 'cf config' to set a custom key path.[/yellow]")
+        raise click.Abort()
+
+    # Load and update project.json
+    project_json_path = Path(project_root) / '.cf' / 'project.json'
+    if not project_json_path.exists():
+        console.print(f"[red]Project configuration not found at {project_json_path}[/red]")
+        console.print("[yellow]Please run 'cf init' first to initialize your project.[/yellow]")
+        raise click.Abort()
+    
+    # Load existing project.json
+    try:
+        with open(project_json_path, 'r') as f:
+            project_data = json.load(f)
+    except Exception as e:
+        console.print(f"[red]Failed to read project.json: {e}[/red]")
+        raise click.Abort()
+    
+    # Set submission_state to Final
+    if "project" not in project_data:
+        project_data["project"] = {}
+    
+    project_data["project"]["submission_state"] = "Final"
+    
+    # Save updated project.json
+    try:
+        with open(project_json_path, 'w') as f:
+            json.dump(project_data, f, indent=2)
+        console.print("[green]✓ Updated project.json with submission_state = Final[/green]")
+    except Exception as e:
+        console.print(f"[red]Failed to update project.json: {e}[/red]")
+        raise click.Abort()
+    
+    # Get final project name for SFTP upload
+    final_project_name = project_name or project_data.get("project", {}).get("name")
+    if not final_project_name:
+        console.print("[red]No project name found in project.json. Please provide --project-name.[/red]")
+        raise click.Abort()
+    
+    # Connect to SFTP and upload project.json
+    console.print(f"Connecting to {sftp_host}...")
+    transport = None
+    try:
+        sftp, transport = sftp_connect(
+            host=sftp_host,
+            username=sftp_username,
+            key_path=key_path
+        )
+        # Ensure the project directory exists before uploading
+        sftp_project_dir = f"incoming/projects/{final_project_name}"
+        sftp_ensure_dirs(sftp, sftp_project_dir)
+    except Exception as e:
+        console.print(f"[red]Failed to connect to SFTP: {e}[/red]")
+        raise click.Abort()
+    
+    try:
+        # Upload only the project.json file
+        remote_path = os.path.join(sftp_project_dir, ".cf", "project.json")
+        upload_with_progress(
+            sftp,
+            local_path=str(project_json_path),
+            remote_path=remote_path,
+            force_overwrite=True  # Always overwrite for confirmation
+        )
+        console.print(f"[green]✓ Confirmed project submission: {final_project_name}[/green]")
+        console.print(f"[green]✓ Uploaded project.json to {remote_path}[/green]")
+        
+    except Exception as e:
+        console.print(f"[red]Upload failed: {e}[/red]")
+        raise click.Abort()
+    finally:
+        if transport:
+            sftp.close()
+            transport.close()
+
 if __name__ == "__main__":
     main() 

chipfoundry_cli/utils.py

@@ -158,7 +158,7 @@ def update_or_create_project_json(
 ) -> str:
     """
     Update or create project.json in cf_dir. If existing_json_path is given, load and update it.
-    Otherwise, create a new one. Always update the user_project_wrapper_hash.
+    Otherwise, create a new one. Always update the user_project_wrapper_hash and auto-increment version.
     Returns the path to the updated/created project.json.
     """
     project_json_path = str(Path(cf_dir) / "project.json")
@@ -169,14 +169,37 @@ def update_or_create_project_json(
             data["project"] = {}
     else:
         data = {"project": {}}
+    
+    # Handle version auto-increment only if GDS hash changed
+    current_version = data["project"].get("version")
+    current_hash = data["project"].get("user_project_wrapper_hash", "")
+    
+    if current_version is None:
+        # No existing version, start with 1
+        new_version = "1"
+    elif current_hash != hash_val:
+        # GDS hash changed, increment version
+        try:
+            # Convert to int, increment, and convert back to string
+            version_num = int(current_version)
+            new_version = str(version_num + 1)
+        except (ValueError, TypeError):
+            # If version is not a valid integer, start from 1
+            new_version = "1"
+    else:
+        # GDS hash unchanged, keep same version
+        new_version = current_version
+    
     # Required fields with defaults
-    data["project"].setdefault("version", "1.0.0")
+    data["project"]["version"] = new_version
     data["project"]["user_project_wrapper_hash"] = hash_val
-    # Apply CLI overrides
-    for key in ["id", "name", "type", "user", "version"]:
+    
+    # Apply CLI overrides (but don't override auto-incremented version)
+    for key in ["id", "name", "type", "user"]:  # Removed "version" from CLI overrides
         cli_key = f"project_{key}" if key != "user" else "sftp_username"
         if cli_key in cli_overrides and cli_overrides[cli_key] is not None:
             data["project"][key] = cli_overrides[cli_key]
+    
     save_project_json(project_json_path, data)
     return project_json_path