chipfoundry-cli 1.0.0__tar.gz → 1.0.2__tar.gz

chipfoundry_cli-1.0.2/PKG-INFO

@@ -0,0 +1,307 @@
+Metadata-Version: 2.1
+Name: chipfoundry-cli
+Version: 1.0.2
+Summary: CLI tool to automate ChipFoundry project submission to SFTP server
+Home-page: https://chipfoundry.io
+License: Apache-2.0
+Author: ChipFoundry
+Author-email: marwan.abbas@chipfoundry.io
+Requires-Python: >=3.8.0
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: click (>=8.0.0,<9)
+Requires-Dist: paramiko (>=3.0.0,<4)
+Requires-Dist: rich (>=13,<14)
+Requires-Dist: toml (>=0.10,<1.0)
+Project-URL: Repository, https://github.com/chipfoundry/cf-cli
+Description-Content-Type: text/markdown
+
+# ChipFoundry CLI (`cf-cli`)
+
+[![PyPI version](https://img.shields.io/pypi/v/chipfoundry-cli?color=blue)](https://badge.fury.io/py/chipfoundry-cli)
+[![PyPI downloads](https://img.shields.io/pypi/dm/chipfoundry-cli.svg)](https://pypi.org/project/chipfoundry-cli/)
+
+A command-line tool to automate the submission of ChipFoundry projects to the SFTP server.
+
+---
+
+## Overview
+
+`cf-cli` is a user-friendly command-line tool for securely submitting your ChipFoundry project files to the official SFTP server. It automatically collects the required files, generates or updates your project configuration, and uploads everything to the correct location on the server.
+
+---
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install chipfoundry-cli
+cf --help
+```
+
+---
+
+## Quick Start
+
+1. **Generate SSH Key** (if you don't have one):
+   ```bash
+   cf keygen
+   ```
+
+2. **Register your key** at [https://chipfoundry.io/sftp-registration](https://chipfoundry.io/sftp-registration)
+
+3. **Configure your credentials**:
+   ```bash
+   cf config
+   ```
+
+4. **Initialize your project**:
+   ```bash
+   cf init
+   ```
+
+5. **Upload your project**:
+   ```bash
+   cf push
+   ```
+
+---
+
+## Project Structure Requirements
+
+Your project directory **must** contain:
+
+- `gds/` directory with **one** of the following:
+  - `user_project_wrapper.gds` (for digital projects)
+  - `user_analog_project_wrapper.gds` (for analog projects)
+  - `openframe_project_wrapper.gds` (for openframe projects)
+- `verilog/rtl/user_defines.v` (required for digital/analog)
+- `.cf/project.json` (optional; will be created/updated automatically)
+
+**Example:**
+```
+my_project/
+├── gds/
+│   └── user_project_wrapper.gds
+├── verilog/
+│   └── rtl/
+│       └── user_defines.v
+└── .cf/
+    └── project.json
+```
+
+---
+
+## Authentication
+
+The CLI uses SSH key authentication for secure SFTP access:
+
+- **Default key location**: `~/.ssh/chipfoundry-key` (generated by `cf keygen`)
+- **Alternative key**: Specify with `--sftp-key` option
+- **SFTP username**: Required and configured via `cf config`
+
+---
+
+## SFTP Server
+
+- **Default server**: `sftp.chipfoundry.io`
+- **Username format**: `firstname-lastname` (e.g., `john-doe`)
+
+---
+
+## Commands
+
+### Generate SSH Key
+
+```bash
+cf keygen [--overwrite]
+```
+
+- Generates a new RSA SSH key at `~/.ssh/chipfoundry-key`
+- Displays the public key for registration
+- Use `--overwrite` to regenerate an existing key
+- **Next step**: Submit the public key to [https://chipfoundry.io/sftp-registration](https://chipfoundry.io/sftp-registration)
+
+### View SSH Key
+
+```bash
+cf keyview
+```
+
+- Displays the current ChipFoundry SSH public key
+- Useful for viewing your key without generating a new one
+- Shows the same registration instructions as `cf keygen`
+
+### Configure User Credentials
+
+```bash
+cf config
+```
+
+- Prompts for your SFTP username and key path
+- Defaults to `~/.ssh/chipfoundry-key`
+- Only needs to be run once per user/machine
+
+### Initialize a New Project
+
+```bash
+cf init [--project-root DIRECTORY]
+```
+
+- **Smart defaults**: Auto-detects project name from directory and project type from GDS files
+- **Interactive prompts**: Shows detected values in prompts for easy acceptance
+- Creates `.cf/project.json` with project metadata
+- **Note**: GDS hash is generated during `push`, not `init`
+
+### Push a Project (Upload)
+
+```bash
+cf push [OPTIONS]
+```
+
+**Options:**
+- `--project-root`: Specify project directory
+- `--force-overwrite`: Overwrite existing files on SFTP
+- `--dry-run`: Preview what would be uploaded
+- `--sftp-username`: Override configured username
+- `--sftp-key`: Override configured key path
+
+**What happens:**
+1. Collects required project files
+2. Auto-detects project type from GDS file
+3. Updates project configuration and GDS hash
+4. Uploads files to SFTP with progress bars
+5. Shows clean, informative output
+
+### Pull Results
+
+```bash
+cf pull [--project-name NAME]
+```
+
+- Downloads project results from SFTP
+- Saves to `sftp-output/<project_name>/`
+- Shows download progress for each file
+
+### Check Status
+
+```bash
+cf status
+```
+
+- Lists all your projects on the SFTP server
+- Shows which projects have input files and/or results
+- Displays project status in a clean table format
+
+---
+
+## How the GDS Hash Works
+
+- The `user_project_wrapper_hash` in `.cf/project.json` is **automatically generated and updated during `push`**
+- The hash is calculated from the actual GDS file being uploaded
+- This ensures the hash always matches the file you are submitting
+- **You do not need to manage or update the hash manually**
+- The hash is NOT generated during `init` because the GDS file may not exist or may change before submission
+
+---
+
+## What Happens When You Run `cf push`?
+
+1. **File Collection:**
+   - Checks for required GDS and Verilog files
+   - Auto-detects project type (digital, analog, openframe) based on GDS file name
+
+2. **Configuration:**
+   - Creates or updates `.cf/project.json`
+   - Updates the GDS hash and any CLI-overridden fields
+
+3. **SFTP Upload:**
+   - Connects to the SFTP server securely
+   - Creates project directory structure
+   - Uploads files with progress indicators
+   - Shows clean, minimal output
+
+4. **Success:**
+   - Displays confirmation with project location
+
+---
+
+## Examples
+
+### Basic Workflow
+
+```bash
+# Generate SSH key and register it
+cf keygen
+# Copy the displayed key to https://chipfoundry.io/sftp-registration
+
+# Configure your account
+cf config
+# Enter: john-doe
+# Enter: (press Enter for default key)
+
+# Initialize project (in your project directory)
+cf init
+# Project name (detected: my_awesome_project): 
+# Project type (digital/analog/openframe) (detected: digital): 
+
+# Upload your project
+cf push
+# Connecting to sftp.chipfoundry.io...
+# Uploading project.json ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100%
+# Uploading user_project_wrapper.gds ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100%
+# ✓ Uploaded to incoming/projects/my_awesome_project
+```
+
+### Advanced Usage
+
+```bash
+# Preview what would be uploaded
+cf push --dry-run
+
+# Force overwrite existing files
+cf push --force-overwrite
+
+# Use different project root
+cf push --project-root /path/to/project
+
+# Check project status
+cf status
+```
+
+---
+
+## Troubleshooting
+
+- **Missing files:**
+  - The tool will error out if required files are missing or if more than one GDS type is present
+
+- **Authentication errors:**
+  - Run `cf keygen` to generate a new key
+  - Ensure your key is registered at [https://chipfoundry.io/sftp-registration](https://chipfoundry.io/sftp-registration)
+  - Check your username with `cf config`
+
+- **SFTP errors:**
+  - Check your network connection
+  - Verify your credentials with `cf config`
+
+- **Project type detection:**
+  - Only one of the recognized GDS files should be present in your `gds/` directory
+
+- **ModuleNotFoundError:**
+  - Upgrade the CLI: `pip install --upgrade chipfoundry-cli`
+
+---
+
+## Support
+
+- For help, contact info@chipfoundry.io or visit [chipfoundry.io](https://chipfoundry.io)
+- For bug reports or feature requests, open an issue on [GitHub](https://github.com/chipfoundry/cf-cli)
+

chipfoundry_cli-1.0.2/README.md

@@ -0,0 +1,282 @@
+# ChipFoundry CLI (`cf-cli`)
+
+[![PyPI version](https://img.shields.io/pypi/v/chipfoundry-cli?color=blue)](https://badge.fury.io/py/chipfoundry-cli)
+[![PyPI downloads](https://img.shields.io/pypi/dm/chipfoundry-cli.svg)](https://pypi.org/project/chipfoundry-cli/)
+
+A command-line tool to automate the submission of ChipFoundry projects to the SFTP server.
+
+---
+
+## Overview
+
+`cf-cli` is a user-friendly command-line tool for securely submitting your ChipFoundry project files to the official SFTP server. It automatically collects the required files, generates or updates your project configuration, and uploads everything to the correct location on the server.
+
+---
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install chipfoundry-cli
+cf --help
+```
+
+---
+
+## Quick Start
+
+1. **Generate SSH Key** (if you don't have one):
+   ```bash
+   cf keygen
+   ```
+
+2. **Register your key** at [https://chipfoundry.io/sftp-registration](https://chipfoundry.io/sftp-registration)
+
+3. **Configure your credentials**:
+   ```bash
+   cf config
+   ```
+
+4. **Initialize your project**:
+   ```bash
+   cf init
+   ```
+
+5. **Upload your project**:
+   ```bash
+   cf push
+   ```
+
+---
+
+## Project Structure Requirements
+
+Your project directory **must** contain:
+
+- `gds/` directory with **one** of the following:
+  - `user_project_wrapper.gds` (for digital projects)
+  - `user_analog_project_wrapper.gds` (for analog projects)
+  - `openframe_project_wrapper.gds` (for openframe projects)
+- `verilog/rtl/user_defines.v` (required for digital/analog)
+- `.cf/project.json` (optional; will be created/updated automatically)
+
+**Example:**
+```
+my_project/
+├── gds/
+│   └── user_project_wrapper.gds
+├── verilog/
+│   └── rtl/
+│       └── user_defines.v
+└── .cf/
+    └── project.json
+```
+
+---
+
+## Authentication
+
+The CLI uses SSH key authentication for secure SFTP access:
+
+- **Default key location**: `~/.ssh/chipfoundry-key` (generated by `cf keygen`)
+- **Alternative key**: Specify with `--sftp-key` option
+- **SFTP username**: Required and configured via `cf config`
+
+---
+
+## SFTP Server
+
+- **Default server**: `sftp.chipfoundry.io`
+- **Username format**: `firstname-lastname` (e.g., `john-doe`)
+
+---
+
+## Commands
+
+### Generate SSH Key
+
+```bash
+cf keygen [--overwrite]
+```
+
+- Generates a new RSA SSH key at `~/.ssh/chipfoundry-key`
+- Displays the public key for registration
+- Use `--overwrite` to regenerate an existing key
+- **Next step**: Submit the public key to [https://chipfoundry.io/sftp-registration](https://chipfoundry.io/sftp-registration)
+
+### View SSH Key
+
+```bash
+cf keyview
+```
+
+- Displays the current ChipFoundry SSH public key
+- Useful for viewing your key without generating a new one
+- Shows the same registration instructions as `cf keygen`
+
+### Configure User Credentials
+
+```bash
+cf config
+```
+
+- Prompts for your SFTP username and key path
+- Defaults to `~/.ssh/chipfoundry-key`
+- Only needs to be run once per user/machine
+
+### Initialize a New Project
+
+```bash
+cf init [--project-root DIRECTORY]
+```
+
+- **Smart defaults**: Auto-detects project name from directory and project type from GDS files
+- **Interactive prompts**: Shows detected values in prompts for easy acceptance
+- Creates `.cf/project.json` with project metadata
+- **Note**: GDS hash is generated during `push`, not `init`
+
+### Push a Project (Upload)
+
+```bash
+cf push [OPTIONS]
+```
+
+**Options:**
+- `--project-root`: Specify project directory
+- `--force-overwrite`: Overwrite existing files on SFTP
+- `--dry-run`: Preview what would be uploaded
+- `--sftp-username`: Override configured username
+- `--sftp-key`: Override configured key path
+
+**What happens:**
+1. Collects required project files
+2. Auto-detects project type from GDS file
+3. Updates project configuration and GDS hash
+4. Uploads files to SFTP with progress bars
+5. Shows clean, informative output
+
+### Pull Results
+
+```bash
+cf pull [--project-name NAME]
+```
+
+- Downloads project results from SFTP
+- Saves to `sftp-output/<project_name>/`
+- Shows download progress for each file
+
+### Check Status
+
+```bash
+cf status
+```
+
+- Lists all your projects on the SFTP server
+- Shows which projects have input files and/or results
+- Displays project status in a clean table format
+
+---
+
+## How the GDS Hash Works
+
+- The `user_project_wrapper_hash` in `.cf/project.json` is **automatically generated and updated during `push`**
+- The hash is calculated from the actual GDS file being uploaded
+- This ensures the hash always matches the file you are submitting
+- **You do not need to manage or update the hash manually**
+- The hash is NOT generated during `init` because the GDS file may not exist or may change before submission
+
+---
+
+## What Happens When You Run `cf push`?
+
+1. **File Collection:**
+   - Checks for required GDS and Verilog files
+   - Auto-detects project type (digital, analog, openframe) based on GDS file name
+
+2. **Configuration:**
+   - Creates or updates `.cf/project.json`
+   - Updates the GDS hash and any CLI-overridden fields
+
+3. **SFTP Upload:**
+   - Connects to the SFTP server securely
+   - Creates project directory structure
+   - Uploads files with progress indicators
+   - Shows clean, minimal output
+
+4. **Success:**
+   - Displays confirmation with project location
+
+---
+
+## Examples
+
+### Basic Workflow
+
+```bash
+# Generate SSH key and register it
+cf keygen
+# Copy the displayed key to https://chipfoundry.io/sftp-registration
+
+# Configure your account
+cf config
+# Enter: john-doe
+# Enter: (press Enter for default key)
+
+# Initialize project (in your project directory)
+cf init
+# Project name (detected: my_awesome_project): 
+# Project type (digital/analog/openframe) (detected: digital): 
+
+# Upload your project
+cf push
+# Connecting to sftp.chipfoundry.io...
+# Uploading project.json ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100%
+# Uploading user_project_wrapper.gds ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100%
+# ✓ Uploaded to incoming/projects/my_awesome_project
+```
+
+### Advanced Usage
+
+```bash
+# Preview what would be uploaded
+cf push --dry-run
+
+# Force overwrite existing files
+cf push --force-overwrite
+
+# Use different project root
+cf push --project-root /path/to/project
+
+# Check project status
+cf status
+```
+
+---
+
+## Troubleshooting
+
+- **Missing files:**
+  - The tool will error out if required files are missing or if more than one GDS type is present
+
+- **Authentication errors:**
+  - Run `cf keygen` to generate a new key
+  - Ensure your key is registered at [https://chipfoundry.io/sftp-registration](https://chipfoundry.io/sftp-registration)
+  - Check your username with `cf config`
+
+- **SFTP errors:**
+  - Check your network connection
+  - Verify your credentials with `cf config`
+
+- **Project type detection:**
+  - Only one of the recognized GDS files should be present in your `gds/` directory
+
+- **ModuleNotFoundError:**
+  - Upgrade the CLI: `pip install --upgrade chipfoundry-cli`
+
+---
+
+## Support
+
+- For help, contact info@chipfoundry.io or visit [chipfoundry.io](https://chipfoundry.io)
+- For bug reports or feature requests, open an issue on [GitHub](https://github.com/chipfoundry/cf-cli)

{chipfoundry_cli-1.0.0 → chipfoundry_cli-1.0.2}/chipfoundry_cli/main.py

@@ -140,6 +140,29 @@ def keygen(overwrite):
         console.print(f"[red]Unexpected error: {e}[/red]")
         raise click.Abort()
 
+@main.command('keyview')
+def keyview():
+    """Display the current ChipFoundry SSH key."""
+    ssh_dir = Path.home() / '.ssh'
+    private_key_path = ssh_dir / 'chipfoundry-key'
+    public_key_path = ssh_dir / 'chipfoundry-key.pub'
+    
+    if not public_key_path.exists():
+        console.print("[red]No ChipFoundry SSH key found.[/red]")
+        console.print("[yellow]Run 'cf keygen' to generate a new key.[/yellow]")
+        raise click.Abort()
+    
+    console.print("[cyan]Your ChipFoundry SSH public key:[/cyan]")
+    with open(public_key_path, 'r') as f:
+        public_key = f.read().strip()
+        print(f"{public_key}")
+    print("")
+    console.print("[bold cyan]Next steps:[/bold cyan]")
+    console.print("1. Copy the public key above")
+    console.print("2. Submit it to the registration form at: https://chipfoundry.io/sftp-registration")
+    console.print("3. Wait for account approval")
+    console.print("4. Use 'cf config' to configure your SFTP credentials")
+
 @main.command('init')
 @click.option('--project-root', required=False, type=click.Path(file_okay=False), help='Directory to create the project in (defaults to current directory).')
 def init(project_root):
@@ -203,13 +226,12 @@ def init(project_root):
 @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('--sftp-password', help='SFTP password. If not provided, will prompt securely.', default=None)
 @click.option('--project-id', help='Project ID (e.g., "user123_proj456"). Overrides project.json if exists.')
 @click.option('--project-name', help='Project name (e.g., "my_project"). Overrides project.json if exists.')
 @click.option('--project-type', help='Project type (auto-detected if not provided).', default=None)
 @click.option('--force-overwrite', is_flag=True, help='Overwrite existing files on SFTP without prompting.')
 @click.option('--dry-run', is_flag=True, help='Preview actions without uploading files.')
-def push(project_root, sftp_host, sftp_username, sftp_key, sftp_password, project_id, project_name, project_type, force_overwrite, dry_run):
+def push(project_root, sftp_host, sftp_username, sftp_key, project_id, project_name, project_type, force_overwrite, dry_run):
     """Upload your project files to the ChipFoundry SFTP server."""
     # 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()
@@ -229,25 +251,17 @@ def push(project_root, sftp_host, sftp_username, sftp_key, sftp_password, projec
             raise click.Abort()
     if not sftp_key:
         sftp_key = config.get("sftp_key")
-    # Determine which authentication method to use
-    key_path = sftp_key
-    password = sftp_password
+    
     # Always resolve key_path to absolute path if set
-    if key_path:
-        key_path = os.path.abspath(os.path.expanduser(key_path))
-    if not key_path and not password:
-        if os.path.exists(DEFAULT_SSH_KEY):
-            key_path = DEFAULT_SSH_KEY
-        else:
-            console.print("[yellow]No SFTP credentials found. Please run 'cf config' first.[/yellow]")
-            raise click.Abort()
-    elif key_path and password:
-        console.print("[red]Options --sftp-password and --sftp-key are mutually exclusive.[/red]")
-        raise click.UsageError("Options --sftp-password and --sftp-key are mutually exclusive.")
-    elif key_path and not password:
-        if not os.path.exists(key_path):
-            console.print(f"[red]SFTP key file not found: {key_path}[/red]")
-            raise click.UsageError(f"SFTP key file not found: {key_path}")
+    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()
 
     # Collect project files
     try:
@@ -321,7 +335,6 @@ def push(project_root, sftp_host, sftp_username, sftp_key, sftp_password, projec
         sftp, transport = sftp_connect(
             host=sftp_host,
             username=sftp_username,
-            password=password,
             key_path=key_path
         )
         # Ensure the project directory exists before uploading
@@ -356,8 +369,7 @@ def push(project_root, sftp_host, sftp_username, sftp_key, sftp_password, projec
 @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('--sftp-password', help='SFTP password. If not provided, will prompt securely.', default=None)
-def pull(project_name, output_dir, sftp_host, sftp_username, sftp_key, sftp_password):
+def pull(project_name, output_dir, sftp_host, sftp_username, sftp_key):
     """Download results/artifacts from SFTP output dir to local sftp-output/<project_name>."""
     # If .cf/project.json exists in cwd, use its project name as default
     _, cwd_project_name = get_project_json_from_cwd()
@@ -374,43 +386,28 @@ def pull(project_name, output_dir, sftp_host, sftp_username, sftp_key, sftp_pass
             raise click.Abort()
     if not sftp_key:
         sftp_key = config.get("sftp_key")
-    key_path = sftp_key
-    password = sftp_password
+    
     # Always resolve key_path to absolute path if set
-    if key_path:
-        key_path = os.path.abspath(os.path.expanduser(key_path))
-    if not key_path and not password:
-        if os.path.exists(DEFAULT_SSH_KEY):
-            key_path = DEFAULT_SSH_KEY
-            console.print(f"[INFO] Using default SSH key: {DEFAULT_SSH_KEY}", style="bold cyan")
-        else:
-            console.print("[WARN] No SFTP key or password provided, and no default key found at ~/.ssh/id_rsa.", style="bold yellow")
-            auth_method = click.prompt("Choose authentication method (key/password)", type=click.Choice(['key', 'password']), show_choices=True)
-            if auth_method == 'key':
-                key_path = click.prompt("Enter path to SFTP private key", type=click.Path(exists=True, dir_okay=False))
-            else:
-                password = click.prompt("SFTP Password", hide_input=True)
-    elif key_path and password:
-        console.print("[ERROR] Options --sftp-password and --sftp-key are mutually exclusive.", style="bold red")
-        raise click.UsageError("Options --sftp-password and --sftp-key are mutually exclusive.")
-    elif not key_path and password:
-        pass  # password provided
-    elif key_path and not password:
-        if not os.path.exists(key_path):
-            console.print(f"[ERROR] SFTP key file not found: {key_path}", style="bold red")
-            raise click.UsageError(f"SFTP key file not found: {key_path}")
+    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()
 
-    console.print(f"[INFO] Connecting to SFTP: {sftp_host} as {sftp_username}", style="bold cyan")
+    console.print(f"Connecting to {sftp_host}...")
     transport = None
     try:
         sftp, transport = sftp_connect(
             host=sftp_host,
             username=sftp_username,
-            password=password,
             key_path=key_path
         )
     except Exception as e:
-        console.print(f"[ERROR] Failed to connect to SFTP: {e}", style="bold red")
+        console.print(f"[red]Failed to connect to SFTP: {e}[/red]")
         raise click.Abort()
     try:
         remote_dir = f"outgoing/results/{project_name}"
@@ -456,54 +453,38 @@ def pull(project_name, output_dir, sftp_host, sftp_username, sftp_key, sftp_pass
 @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('--sftp-password', help='SFTP password. If not provided, will prompt securely.', default=None)
-def status(sftp_host, sftp_username, sftp_key, sftp_password):
+def status(sftp_host, sftp_username, sftp_key):
     """Show all projects and outputs for the user on the SFTP server."""
     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 'chipfoundry init' or provide --sftp-username.[/bold red]")
+            console.print("[red]No SFTP username provided and not found in config. Please run 'cf config' or provide --sftp-username.[/red]")
             raise click.Abort()
     if not sftp_key:
         sftp_key = config.get("sftp_key")
-    key_path = sftp_key
-    password = sftp_password
+    
     # Always resolve key_path to absolute path if set
-    if key_path:
-        key_path = os.path.abspath(os.path.expanduser(key_path))
-    if not key_path and not password:
-        if os.path.exists(DEFAULT_SSH_KEY):
-            key_path = DEFAULT_SSH_KEY
-            console.print(f"[INFO] Using default SSH key: {DEFAULT_SSH_KEY}", style="bold cyan")
-        else:
-            console.print("[WARN] No SFTP key or password provided, and no default key found at ~/.ssh/id_rsa.", style="bold yellow")
-            auth_method = click.prompt("Choose authentication method (key/password)", type=click.Choice(['key', 'password']), show_choices=True)
-            if auth_method == 'key':
-                key_path = click.prompt("Enter path to SFTP private key", type=click.Path(exists=True, dir_okay=False))
-            else:
-                password = click.prompt("SFTP Password", hide_input=True)
-    elif key_path and password:
-        console.print("[ERROR] Options --sftp-password and --sftp-key are mutually exclusive.", style="bold red")
-        raise click.UsageError("Options --sftp-password and --sftp-key are mutually exclusive.")
-    elif not key_path and password:
-        pass  # password provided
-    elif key_path and not password:
-        if not os.path.exists(key_path):
-            console.print(f"[ERROR] SFTP key file not found: {key_path}", style="bold red")
-            raise click.UsageError(f"SFTP key file not found: {key_path}")
+    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()
 
-    console.print(f"[INFO] Connecting to SFTP: {sftp_host} as {sftp_username}", style="bold cyan")
+    console.print(f"Connecting to {sftp_host}...")
     transport = None
     try:
         sftp, transport = sftp_connect(
             host=sftp_host,
             username=sftp_username,
-            password=password,
             key_path=key_path
         )
     except Exception as e:
-        console.print(f"[ERROR] Failed to connect to SFTP: {e}", style="bold red")
+        console.print(f"[red]Failed to connect to SFTP: {e}[/red]")
         raise click.Abort()
     try:
         # List projects in incoming/projects/ and outgoing/results/

{chipfoundry_cli-1.0.0 → chipfoundry_cli-1.0.2}/chipfoundry_cli/utils.py

@@ -121,16 +121,13 @@ def load_private_key(key_path, password=None):
             last_exception = e
     raise RuntimeError(f"Could not load private key: {last_exception}")
 
-def sftp_connect(host: str, username: str, password: str = None, key_path: str = None):
+def sftp_connect(host: str, username: str, key_path: str):
     """
     Establish an SFTP connection using paramiko. Returns an SFTP client.
     """
     transport = paramiko.Transport((host, 22))
-    if key_path:
-        private_key = load_private_key(key_path)
-        transport.connect(username=username, pkey=private_key)
-    else:
-        transport.connect(username=username, password=password)
+    private_key = load_private_key(key_path)
+    transport.connect(username=username, pkey=private_key)
     sftp = paramiko.SFTPClient.from_transport(transport)
     return sftp, transport
 

{chipfoundry_cli-1.0.0 → chipfoundry_cli-1.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "chipfoundry-cli"
-version = "1.0.0"
+version = "1.0.2"
 description = "CLI tool to automate ChipFoundry project submission to SFTP server"
 authors = ["ChipFoundry <marwan.abbas@chipfoundry.io>"]
 readme = "README.md"

chipfoundry_cli-1.0.0/PKG-INFO

@@ -1,177 +0,0 @@
-Metadata-Version: 2.1
-Name: chipfoundry-cli
-Version: 1.0.0
-Summary: CLI tool to automate ChipFoundry project submission to SFTP server
-Home-page: https://chipfoundry.io
-License: Apache-2.0
-Author: ChipFoundry
-Author-email: marwan.abbas@chipfoundry.io
-Requires-Python: >=3.8.0
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: click (>=8.0.0,<9)
-Requires-Dist: paramiko (>=3.0.0,<4)
-Requires-Dist: rich (>=13,<14)
-Requires-Dist: toml (>=0.10,<1.0)
-Project-URL: Repository, https://github.com/chipfoundry/cf-cli
-Description-Content-Type: text/markdown
-
-# ChipFoundry CLI (`cf-cli`)
-
-A command-line tool to automate the submission of ChipFoundry projects to the SFTP server.
-
----
-
-## Overview
-
-`cf-cli` is a user-friendly command-line tool for securely submitting your ChipFoundry project files to the official SFTP server. It automatically collects the required files, generates or updates your project configuration, and uploads everything to the correct location on the server.
-
----
-
-## Installation
-
-Install from PyPI:
-
-```bash
-pip install chipfoundry-cli
-chipfoundry --help
-```
-
----
-
-## Project Structure Requirements
-
-Your project directory **must** contain:
-
-- `gds/` directory with **one** of the following:
-  - `user_project_wrapper.gds` (for digital projects)
-  - `user_analog_project_wrapper.gds` (for analog projects)
-  - `openframe_project_wrapper.gds` (for openframe projects)
-- `verilog/rtl/user_defines.v` (required for digital/analog)
-- `.cf/project.json` (optional; will be created/updated automatically)
-
-**Example:**
-```
-my_project/
-├── gds/
-│   └── user_project_wrapper.gds
-├── verilog/
-│   └── rtl/
-│       └── user_defines.v
-└── .cf/
-    └── project.json
-```
-
----
-
-## Authentication
-
-- By default, the tool will look for an SSH key at `~/.ssh/id_rsa`.
-- You can specify a different key with `--sftp-key`.
-- If no key is found, you will be prompted to enter a key path or your SFTP password.
-- Your SFTP username is required (provided by ChipFoundry).
-
----
-
-## SFTP Server
-
-- The default SFTP server is `sftp.chipfoundry.io` (no need to specify unless you want to override).
-
----
-
-## Usage
-
-### Configure User Credentials
-
-```bash
-chipfoundry config
-```
-- Prompts for your SFTP username and key path. Only needs to be run once per user/machine.
-
-### Initialize a New Project
-
-```bash
-chipfoundry init
-```
-- Prompts for project name, type (auto-detected from GDS file if present), and version.
-- Creates `.cf/project.json` in the current directory.
-- **Note:** The GDS hash is NOT generated at this step (see below).
-
-### Push a Project (Upload)
-
-```bash
-chipfoundry push
-```
-- Run from your project directory (with `.cf/project.json`).
-- Collects files, updates the GDS hash, and uploads to SFTP.
-
-### Pull Results
-
-```bash
-chipfoundry pull
-```
-- Downloads results for the current project to a local directory.
-
-### Check Status
-
-```bash
-chipfoundry status
-```
-- Shows all your projects and their input/output status on the SFTP server.
-
----
-
-## How the GDS Hash Works
-
-- The `user_project_wrapper_hash` in `.cf/project.json` is **automatically generated and updated during `push`**.
-- The hash is calculated from the actual GDS file being uploaded.
-- This ensures the hash always matches the file you are submitting.
-- **You do not need to manage or update the hash manually.**
-- The hash is NOT generated during `init` because the GDS file may not exist or may change before submission.
-
----
-
-## What Happens When You Run `chipfoundry push`?
-
-1. **File Collection:**
-   - The tool checks for the required GDS and Verilog files.
-   - It auto-detects your project type (digital, analog, openframe) based on the GDS file name.
-2. **Configuration:**
-   - If `.cf/project.json` does not exist, it is created.
-   - The tool updates the GDS hash and any fields you override via CLI.
-3. **SFTP Upload:**
-   - Connects to the SFTP server as your user.
-   - Ensures the directory `incoming/projects/<project_name>` exists.
-   - Uploads `.cf/project.json`, the GDS file, and `verilog/rtl/user_defines.v` (if present).
-   - Shows a progress bar for each file upload.
-4. **Success:**
-   - You’ll see a green success message when all files are uploaded.
-
----
-
-## Troubleshooting
-
-- **Missing files:**
-  - The tool will error out if required files are missing or if more than one GDS type is present.
-- **Authentication errors:**
-  - Make sure your SSH key is valid and registered with ChipFoundry, or use your password.
-- **SFTP errors:**
-  - Check your network connection and credentials.
-- **Project type detection:**
-  - Only one of the recognized GDS files should be present in your `gds/` directory.
-- **ModuleNotFoundError: No module named 'toml':**
-  - This means your environment is missing the `toml` dependency. Upgrade `chipfoundry-cli` with `pip install --upgrade chipfoundry-cli`, or install `toml` manually with `pip install 'toml>=0.10,<1.0'`.
-
----
-
-## Support
-
-- For help, contact info@chipfoundry.io or visit [chipfoundry.io](https://chipfoundry.io)
-- For bug reports or feature requests, open an issue on [GitHub](https://github.com/chipfoundry/cf-cli)
-

chipfoundry_cli-1.0.0/README.md

@@ -1,152 +0,0 @@
-# ChipFoundry CLI (`cf-cli`)
-
-A command-line tool to automate the submission of ChipFoundry projects to the SFTP server.
-
----
-
-## Overview
-
-`cf-cli` is a user-friendly command-line tool for securely submitting your ChipFoundry project files to the official SFTP server. It automatically collects the required files, generates or updates your project configuration, and uploads everything to the correct location on the server.
-
----
-
-## Installation
-
-Install from PyPI:
-
-```bash
-pip install chipfoundry-cli
-chipfoundry --help
-```
-
----
-
-## Project Structure Requirements
-
-Your project directory **must** contain:
-
-- `gds/` directory with **one** of the following:
-  - `user_project_wrapper.gds` (for digital projects)
-  - `user_analog_project_wrapper.gds` (for analog projects)
-  - `openframe_project_wrapper.gds` (for openframe projects)
-- `verilog/rtl/user_defines.v` (required for digital/analog)
-- `.cf/project.json` (optional; will be created/updated automatically)
-
-**Example:**
-```
-my_project/
-├── gds/
-│   └── user_project_wrapper.gds
-├── verilog/
-│   └── rtl/
-│       └── user_defines.v
-└── .cf/
-    └── project.json
-```
-
----
-
-## Authentication
-
-- By default, the tool will look for an SSH key at `~/.ssh/id_rsa`.
-- You can specify a different key with `--sftp-key`.
-- If no key is found, you will be prompted to enter a key path or your SFTP password.
-- Your SFTP username is required (provided by ChipFoundry).
-
----
-
-## SFTP Server
-
-- The default SFTP server is `sftp.chipfoundry.io` (no need to specify unless you want to override).
-
----
-
-## Usage
-
-### Configure User Credentials
-
-```bash
-chipfoundry config
-```
-- Prompts for your SFTP username and key path. Only needs to be run once per user/machine.
-
-### Initialize a New Project
-
-```bash
-chipfoundry init
-```
-- Prompts for project name, type (auto-detected from GDS file if present), and version.
-- Creates `.cf/project.json` in the current directory.
-- **Note:** The GDS hash is NOT generated at this step (see below).
-
-### Push a Project (Upload)
-
-```bash
-chipfoundry push
-```
-- Run from your project directory (with `.cf/project.json`).
-- Collects files, updates the GDS hash, and uploads to SFTP.
-
-### Pull Results
-
-```bash
-chipfoundry pull
-```
-- Downloads results for the current project to a local directory.
-
-### Check Status
-
-```bash
-chipfoundry status
-```
-- Shows all your projects and their input/output status on the SFTP server.
-
----
-
-## How the GDS Hash Works
-
-- The `user_project_wrapper_hash` in `.cf/project.json` is **automatically generated and updated during `push`**.
-- The hash is calculated from the actual GDS file being uploaded.
-- This ensures the hash always matches the file you are submitting.
-- **You do not need to manage or update the hash manually.**
-- The hash is NOT generated during `init` because the GDS file may not exist or may change before submission.
-
----
-
-## What Happens When You Run `chipfoundry push`?
-
-1. **File Collection:**
-   - The tool checks for the required GDS and Verilog files.
-   - It auto-detects your project type (digital, analog, openframe) based on the GDS file name.
-2. **Configuration:**
-   - If `.cf/project.json` does not exist, it is created.
-   - The tool updates the GDS hash and any fields you override via CLI.
-3. **SFTP Upload:**
-   - Connects to the SFTP server as your user.
-   - Ensures the directory `incoming/projects/<project_name>` exists.
-   - Uploads `.cf/project.json`, the GDS file, and `verilog/rtl/user_defines.v` (if present).
-   - Shows a progress bar for each file upload.
-4. **Success:**
-   - You’ll see a green success message when all files are uploaded.
-
----
-
-## Troubleshooting
-
-- **Missing files:**
-  - The tool will error out if required files are missing or if more than one GDS type is present.
-- **Authentication errors:**
-  - Make sure your SSH key is valid and registered with ChipFoundry, or use your password.
-- **SFTP errors:**
-  - Check your network connection and credentials.
-- **Project type detection:**
-  - Only one of the recognized GDS files should be present in your `gds/` directory.
-- **ModuleNotFoundError: No module named 'toml':**
-  - This means your environment is missing the `toml` dependency. Upgrade `chipfoundry-cli` with `pip install --upgrade chipfoundry-cli`, or install `toml` manually with `pip install 'toml>=0.10,<1.0'`.
-
----
-
-## Support
-
-- For help, contact info@chipfoundry.io or visit [chipfoundry.io](https://chipfoundry.io)
-- For bug reports or feature requests, open an issue on [GitHub](https://github.com/chipfoundry/cf-cli)