8000 [cli/docs] Provide example commands in the CLI docstrings. · Issue #10079 · ray-project/ray · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
[cli/docs] Provide example commands in the CLI docstrings. #10079
Open
@richardliaw

Description

@richardliaw

Describe your feature request

For example:

(base) ➜  cfgs awless ssh
Error: instance required
USAGE:
  awless ssh [USER@]INSTANCE [flags]

EXAMPLES:
  awless ssh i-8d43b21b                       # using the instance id
  awless ssh redis-prod                       # using name only (other infos are derived)
  awless ssh ec2-user@redis-prod              # forcing the user
  awless ssh 34.215.29.221                    # using the IP
  awless ssh root@34.215.29.221 --port 23     # specifying a port

  awless ssh redis-prod -i keyname            # using AWS keyname (look into ~/.ssh/keyname.pem & ~/.awless/keys/keyname.pem)
  awless ssh redis-prod -i ~/path/toward/key  # specifying a full key path

  awless ssh db-private --through my-bastion  # connect to a private inst through a public one
  awless ssh db-private --private             # connect using the private IP (when you have a VPN, tunnel, etc ...)

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Important issue, but not time-criticalenhancementRequest for new feature and/or capabilitypending-cleanupThis issue is pending cleanup. It will be removed in 2 weeks after being assigned.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0