Skip to content

Commit 052d495

Browse files
authored
Merge pull request #11 from easytocloud/claude/issue-10-20250915-1407
docs: update documentation to match latest code changes
2 parents 92c0d97 + 8489841 commit 052d495

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

CLAUDE.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ The `--aws-env` parameter enables AWS profile organization:
141141
## Code Quality Notes
142142

143143
- Uses modern Python features (pathlib, type hints, f-strings)
144-
- Supports Python 3.9+ (recently updated from 3.8+)
144+
- Supports Python 3.9+ (3.9, 3.10, 3.11, 3.12, 3.13)
145145
- No test suite currently exists
146146
- Uses Click for CLI with proper help text and option validation
147147
- Implements comprehensive error handling with user-friendly messages
@@ -156,11 +156,6 @@ The `--aws-env` parameter enables AWS profile organization:
156156
- Security vulnerabilities in subprocess handling
157157
- High technical debt impacting maintainability
158158

159-
### Improvement Documentation
160-
For comprehensive analysis and improvement plans, see:
161-
- **[ARCHITECTURE_REVIEW.md](./ARCHITECTURE_REVIEW.md)** - Detailed code quality analysis and security review
162-
- **[IMPROVEMENT_ROADMAP.md](./IMPROVEMENT_ROADMAP.md)** - 6-phase improvement plan with timeline and priorities
163-
164159
### Development Standards
165160
When working on this codebase, prioritize:
166161
1. **Type safety** - Add complete type hints to new code

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ cloudX-proxy enables seamless SSH connections from VSCode to EC2 instances using
5757
1. **Python 3.9+** - Required for cloudX-proxy and uv package manager
5858
- [Python Installation Guide](https://www.python.org/downloads/)
5959
- Check your version: `python --version` or `python3 --version`
60-
- Supports Python 3.9, 3.10, 3.11, 3.12+
60+
- Supports Python 3.9, 3.10, 3.11, 3.12, 3.13
6161

6262
2. **AWS CLI v2** - Used to configure AWS profiles and credentials
6363
- [Installation Guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
@@ -352,6 +352,7 @@ Options:
352352
- `--instance` (optional): EC2 instance ID to set up connection for. If provided, skips the instance ID prompt.
353353
- `--hostname` (optional): Hostname to use for SSH configuration. If not provided, a hostname will be generated from the instance ID in non-interactive mode or prompted for in interactive mode.
354354
- `--yes` (flag): Non-interactive mode, use default values for all prompts. Requires sufficient defaults or explicit parameters for all required values.
355+
- `--dry-run` (flag): Preview setup changes without actually executing them. Useful for testing configurations before applying them.
355356

356357
Example usage:
357358
```bash
@@ -386,6 +387,7 @@ Options:
386387
- `--ssh-config` (optional): Path to the SSH config file to use. If provided during setup, should match here.
387388
- `--region` (optional): AWS region to use. If not specified, uses the region from the AWS profile.
388389
- `--aws-env` (optional): AWS environment directory to use. Should match the environment used in setup.
390+
- `--dry-run` (flag): Preview connection workflow without actually executing it. Shows what would happen without making changes.
389391

390392
Example usage:
391393
```bash
@@ -413,6 +415,7 @@ Options:
413415
- `--ssh-config` (optional): Path to the SSH config file to use. If not specified, uses ~/.ssh/vscode/config.
414416
- `--environment` (optional): Filter hosts by environment (e.g., dev, prod). If not specified, shows all environments.
415417
- `--detailed` (flag): Show detailed information including instance IDs.
418+
- `--dry-run` (flag): Preview list output format without actually reading the SSH configuration.
416419

417420
Example usage:
418421
```bash

0 commit comments

Comments
 (0)