api.json

{
	"name": "ec2",
	"description": "Command-line interface to common ec2 operations.",
	"usage": "ec2 <command> [parameters]",
	"options": {
		"--profile": {
			"type": "string",
			"default": "default",
			"description": "The AWS profile to use."
		}
	},
	"commands": {
		"ls": {
			"description": "list ec2 instances",
			"usage": "ec2 ls [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},
				"-f": {
					"name": "fields",
					"type": "csv",
					"description": "Fields to print (options: instance-id,public-ip,name)",
					"default": "instance-id,public-ip,state,type,created"
				},
				"-s": {
					"name": "state",
					"type": "string",
					"description": "Only print instances whose state matches the supplied string.",
					"example": "running"
				},
				"-n": {
					"name": "name",
					"type": "string",
					"description": "Only print instances whose name matches the supplied string.",
					"required": "false"
				},
				"-sort": {
					"name": "sort",
					"type" : "string",
					"description": "The key to sort by",
					"required": "false"
				}
			}
		},
		"ssh": {
			"description": "Connect to an ec2 instance via ssh.",
			"usage": "ec2 ssh [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},
				"-k": {
					"name": "key",
					"type": "string",
					"description": "the key to use",
					"default": null
				},
				"-i": {
					"name": "id",
					"type": "string",
					"description": "the instance id to connect to"
				},
				"-n": {
					"name": "name",
					"type": "string",
					"description": "name of the instance to connect to"
				},
				"-c": {
					"name": "command",
					"type": "string",
					"description": "the command to run"
				}

			}
		},
		"exec": {
			"description": "Execute a remote command on an ec2 instance via ssh",
			"usage": "ec2 exec [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},
				"-k": {
					"name": "key",
					"type": "string",
					"description": "the key to use",
					"default": null
				},
				"-i": {
					"name": "id",
					"type": "string",
					"description": "the instance id to connect to"
				},
				"-n": {
					"name": "name",
					"type": "string",
					"description": "name of the instance to connect to"
				},
				"-c": {
					"name": "command",
					"type": "string",
					"description": "the command to run"
				}
			}
		},
		"sftp": {
			"description": "Transfer files with an ec2 instance via sftp.",
			"usage": "ec2 sftp [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},
				"-k": {
					"name": "key",
					"type": "string",
					"description": "the key to use",
					"default": null
				},
				"-i": {
					"name": "id",
					"type": "string",
					"description": "the instance id to connect to"
				},
				"-n": {
					"name": "name",
					"type": "string",
					"description": "name of the instance to connect to"
				}
			}
		},
		"mount": {
			"description": "Mount an ec2 instance locally via sshfs.",
			"usage": "ec2 mount [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},
				"-k": {
					"name": "key",
					"type": "string",
					"description": "the key to use",
					"default": null
				},
				"-i": {
					"name": "id",
					"type": "string",
					"description": "the instance id to connect to"
				},
				"-n": {
					"name": "name",
					"type": "string",
					"description": "name of the instance to connect to"
				}
			}
		},
		"umount": {
			"description": "Unmount a locally mounted ec2 instance",
			"usage": "ec2 umount [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},
				"-h": {
					"name": "host",
					"description": "The directory to which the instance is mounted",
					"type": "string"
				},
				"-n": {
					"name": "name",
					"type": "string",
					"description": "name of instance to connect to"
				}
			}
		},
		"start": {
			"description": "start existing ec2 instances",
			"usage": "ec2 start [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},				
				"-i": {
					"name": "id",
					"type": "string",
					"description": "id of instance to start"
				},
				"-n": {
					"name": "name",
					"description": "name of instance to start",
					"type": "string"
				}
			}
		},
		"stop": {
			"description": "stop existing ec2 instances",
			"usage": "ec2 stop [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},
				"-i": {
					"name": "id",
					"type": "string",
					"description": "id of instance to stop"
				},
				"-n": {
					"name": "name",
					"description": "names of instance to start",
					"type": "string"
				}				
			}
		},
		"terminate": {
			"description": "terminate existing ec2 instances",
			"usage": "ec2 terminate [parameters]",
			"parameters": {
				"-p": {
					"name": "profile",
					"type": "string",
					"description": "The AWS profile to use",
					"default": "default"
				},
				"-id": {
					"type": "string",
					"description": "id of instance to terminate"
				},
				"-n": {
					"description": "name of instance to terminate",
					"type": "string"
				}
			}
		},
		"configure": {
			"description": "Configure AWS credentials.",
			"usage": "ec2 configure",
			"parameters": {}
		},
		"help": {
			"description": "display help",
			"usage": "ec2 help [cmd]",
			"parameters": {}
		}
	}
}