cloudx-proxy 0.3.1__py3-none-any.whl → 0.3.2__py3-none-any.whl

cloudx_proxy/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.1'
-__version_tuple__ = version_tuple = (0, 3, 1)
+__version__ = version = '0.3.2'
+__version_tuple__ = version_tuple = (0, 3, 2)

{cloudx_proxy-0.3.1.dist-info → cloudx_proxy-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cloudx-proxy
-Version: 0.3.1
+Version: 0.3.2
 Summary: SSH proxy command to connect VSCode with Cloud9/CloudX instance using AWS Systems Manager
 Author-email: easytocloud <info@easytocloud.com>
 License: MIT License
@@ -163,28 +163,62 @@ When adding new instances to an existing environment, the setup command will onl
 
 ## Usage
 
-### Command Line
+### Command Line Options
 
+#### Setup Command
 ```bash
-# Setup new environment and instance
-uvx cloudx-proxy setup --profile myprofile --aws-env prod
+uvx cloudx-proxy setup [OPTIONS]
+```
+
+Options:
+- `--profile` (default: vscode): AWS profile to use. The profile's IAM user should follow the format cloudX-{env}-{user}. The environment part will be used as the default environment during setup.
+- `--ssh-key` (default: vscode): Name of the SSH key to create/use. The key will be stored in ~/.ssh/vscode/{name}. This same name can be used in the connect command.
+- `--aws-env` (optional): AWS environment directory to use. If specified, AWS configuration and credentials will be read from ~/.aws/aws-envs/{env}/.
+
+Example usage:
+```bash
+# Basic setup with defaults
+uvx cloudx-proxy setup
 
-# Add instance to existing environment
+# Setup with custom profile and key
+uvx cloudx-proxy setup --profile myprofile --ssh-key mykey
+
+# Setup with AWS environment
 uvx cloudx-proxy setup --profile myprofile --aws-env prod
+```
 
-# Connect to instance
-uvx cloudx-proxy connect i-0123456789abcdef0 22 --profile myprofile --aws-env prod
+#### Connect Command
+```bash
+uvx cloudx-proxy connect INSTANCE_ID [PORT] [OPTIONS]
+```
+
+Arguments:
+- `INSTANCE_ID`: The EC2 instance ID to connect to (e.g., i-0123456789abcdef0)
+- `PORT` (default: 22): The port to forward for SSH connection
 
-# Connect with custom port
-uvx cloudx-proxy connect i-0123456789abcdef0 2222 --profile myprofile
+Options:
+- `--profile` (default: vscode): AWS profile to use. Should match the profile used in setup.
+- `--ssh-key` (default: vscode): Name of the SSH key to use. Should match the key name used in setup.
+- `--region` (optional): AWS region to use. If not specified, uses the region from the AWS profile.
+- `--aws-env` (optional): AWS environment directory to use. Should match the environment used in setup.
 
-# Connect with different region
-uvx cloudx-proxy connect i-0123456789abcdef0 22 --region us-east-1
+Example usage:
+```bash
+# Connect using defaults
+uvx cloudx-proxy connect i-0123456789abcdef0
+
+# Connect with custom profile and key
+uvx cloudx-proxy connect i-0123456789abcdef0 22 --profile myprofile --ssh-key mykey
+
+# Connect with custom port and region
+uvx cloudx-proxy connect i-0123456789abcdef0 2222 --region us-east-1
 
-# Connect with custom key
-uvx cloudx-proxy connect i-0123456789abcdef0 22 --key-path ~/.ssh/custom_key.pub
+# Connect with AWS environment
+uvx cloudx-proxy connect i-0123456789abcdef0 22 --profile myprofile --aws-env prod
 ```
 
+Note: The connect command is typically used through the SSH ProxyCommand configuration set up by the setup command. You rarely need to run it directly unless testing the connection.
+
 ### VSCode
 
 1. Click the "Remote Explorer" icon in the VSCode sidebar

cloudx_proxy-0.3.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+cloudx_proxy/__init__.py,sha256=ZZ2O_m9OFJm18AxMSuYJt4UjSuSqyJlYRaZMoets498,61
+cloudx_proxy/_version.py,sha256=9jP8Fo8egXoMs_T3DFqSuJYg4n9o9mnwYubl_hnut4k,411
+cloudx_proxy/cli.py,sha256=Ph-m8lDsdU2zZab9Y6YgBBzd_UDouBnfNrYFFx0bI_E,3426
+cloudx_proxy/core.py,sha256=WjKoqMmmnt6e_4JMeq4gTka75JAvQcMUs9r9XUBLmFE,7289
+cloudx_proxy/setup.py,sha256=Y8YYMJ47fb57FAr6llQaFGuVOQ-fstYEg_Pdv5uCd-A,22486
+cloudx_proxy-0.3.2.dist-info/LICENSE,sha256=i7P2OR4zsJYsMWcCUDe_B9ZfGi9bU0K5I2nKfDrW_N8,1068
+cloudx_proxy-0.3.2.dist-info/METADATA,sha256=4AL8y6Qeg--nos0FquyZcxUSXY-EkuUBwgSqZ0-5hCw,11736
+cloudx_proxy-0.3.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+cloudx_proxy-0.3.2.dist-info/entry_points.txt,sha256=HGt743N2lVlKd7O1qWq3C0aEHyS5PjPnxzDHh7hwtSg,54
+cloudx_proxy-0.3.2.dist-info/top_level.txt,sha256=2wtEote1db21j-VvkCJFfT-dLlauuG5indjggYh3xDg,13
+cloudx_proxy-0.3.2.dist-info/RECORD,,

cloudx_proxy-0.3.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-cloudx_proxy/__init__.py,sha256=ZZ2O_m9OFJm18AxMSuYJt4UjSuSqyJlYRaZMoets498,61
-cloudx_proxy/_version.py,sha256=HzPz9rq3s1AiZXregKlqKaJJ2wGMtvH_a3V9la9CnpM,411
-cloudx_proxy/cli.py,sha256=Ph-m8lDsdU2zZab9Y6YgBBzd_UDouBnfNrYFFx0bI_E,3426
-cloudx_proxy/core.py,sha256=WjKoqMmmnt6e_4JMeq4gTka75JAvQcMUs9r9XUBLmFE,7289
-cloudx_proxy/setup.py,sha256=Y8YYMJ47fb57FAr6llQaFGuVOQ-fstYEg_Pdv5uCd-A,22486
-cloudx_proxy-0.3.1.dist-info/LICENSE,sha256=i7P2OR4zsJYsMWcCUDe_B9ZfGi9bU0K5I2nKfDrW_N8,1068
-cloudx_proxy-0.3.1.dist-info/METADATA,sha256=9IDcysHjzmeyFMs0ODmS6gfC98rXcCyj-Ug2RsJBxyI,10216
-cloudx_proxy-0.3.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-cloudx_proxy-0.3.1.dist-info/entry_points.txt,sha256=HGt743N2lVlKd7O1qWq3C0aEHyS5PjPnxzDHh7hwtSg,54
-cloudx_proxy-0.3.1.dist-info/top_level.txt,sha256=2wtEote1db21j-VvkCJFfT-dLlauuG5indjggYh3xDg,13
-cloudx_proxy-0.3.1.dist-info/RECORD,,