shark
v2.3.0
Published
A CLI to interact with DigitalOcean
Downloads
681
Maintainers
Readme
shark
A CLI to interact with digitalocean
Usage
$ npm install -g shark
$ shark COMMAND
running command...
$ shark (-v|--version|version)
shark/2.3.0 linux-x64 node-v10.9.0
$ shark --help [COMMAND]
USAGE
$ shark COMMAND
...
Commands
shark actions:get
shark actions:list
shark domains
shark domains:create
shark domains:delete
shark domains:list
shark droplets:backups
shark droplets:create
shark droplets:delete
shark droplets:list
shark droplets:password
shark droplets:power
shark droplets:shutdown
shark droplets:snapshot
shark help [COMMAND]
shark projects:create
shark projects:list
shark records:create
shark records:delete
shark records:list
shark snapshots:delete
shark snapshots:get
shark snapshots:list
shark ssh_keys:create
shark ssh_keys:delete
shark ssh_keys:get
shark ssh_keys:list
shark token:delete
shark volumes:attach
shark volumes:create
shark volumes:delete
shark volumes:detach
shark volumes:get
shark volumes:list
shark actions:get
get details about a specific action
USAGE
$ shark actions:get
OPTIONS
-i, --id=id pass the action id
--json output in json format
See code: src/commands/actions/get.js
shark actions:list
List all executed actions
USAGE
$ shark actions:list
OPTIONS
-j, --json output in json format
-p, --page=page specific page to request
-x, --extended show extra columns
--columns=columns only show provided columns (comma-seperated)
--csv output is csv format
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort
See code: src/commands/actions/list.js
shark domains
perform domain related operations
USAGE
$ shark domains
See code: src/commands/domains/index.js
shark domains:create
Create a domain in DigitalOcean dns
USAGE
$ shark domains:create
OPTIONS
-i, --ip=ip IP address
-n, --name=name Domain name
--json output in json format
DESCRIPTION
Example:
$ shark domains:create --name=satyarohith.com --ip=1.1.1.1
See code: src/commands/domains/create.js
shark domains:delete
Delete domains from DigitalOcean
USAGE
$ shark domains:delete
OPTIONS
-n, --name=name domain name
See code: src/commands/domains/delete.js
shark domains:list
List all domains in your account
USAGE
$ shark domains:list
OPTIONS
-j, --json output in json format
-p, --page=page specific page to request
-x, --extended show extra columns
--columns=columns only show provided columns (comma-seperated)
--csv output is csv format
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort
See code: src/commands/domains/list.js
shark droplets:backups
enable/disable backups for a droplet
USAGE
$ shark droplets:backups
OPTIONS
-d, --disable disable backups
-e, --enable enable backups
-i, --id=id (required) droplet ID
-j, --json output in json format
See code: src/commands/droplets/backups.js
shark droplets:create
create a droplet
USAGE
$ shark droplets:create
OPTIONS
-I, --ipv6 IPv6 public address
-P, --no-prompts disable interactive prompts
-b, --backups enable automated backups
-d, --user_data=user_data user data to upload
-i, --image=image (required) operating system to use
-j, --json output in json format
-k, --ssh_keys=ssh_keys sshkey IDs to attach to the droplet
-m, --monitoring enable droplet monitoring
-n, --name=name (required) name of the droplet
-p, --private_networking enable private networking
-r, --region=region (required) region of the droplet
-s, --size=size (required) size of the droplet
--tags=tags tags
--volumes=volumes volume IDs
See code: src/commands/droplets/create.js
shark droplets:delete
delete a droplet
USAGE
$ shark droplets:delete
OPTIONS
-i, --id=id pass the id of the droplet
DESCRIPTION
Examples:
delete a single droplet:
shark droplets:delete --id 123456
See code: src/commands/droplets/delete.js
shark droplets:list
List droplets under your account
USAGE
$ shark droplets:list
OPTIONS
-j, --json output in json format
-p, --page=page specific page to request
-x, --extended show extra columns
--columns=columns only show provided columns (comma-seperated)
--csv output is csv format
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort
See code: src/commands/droplets/list.js
shark droplets:password
password reset a droplet
USAGE
$ shark droplets:password
OPTIONS
-i, --id=id droplet ID
-j, --json output in json format
See code: src/commands/droplets/password.js
shark droplets:power
power on/off/cycle a droplet
USAGE
$ shark droplets:power
OPTIONS
-c, --cycle power cycle (off and on) a droplet
-f, --off power off droplet
-i, --id=id (required) droplet ID
-j, --json output in json format
-o, --on power on droplet
See code: src/commands/droplets/power.js
shark droplets:shutdown
shutdown a droplet
USAGE
$ shark droplets:shutdown
OPTIONS
-i, --id=id (required) droplet ID
-j, --json output in json format
See code: src/commands/droplets/shutdown.js
shark droplets:snapshot
snapshot a droplet
USAGE
$ shark droplets:snapshot
OPTIONS
-i, --id=id droplet ID
-j, --json output in json format
-n, --name=name give name to the new snapshot
See code: src/commands/droplets/snapshot.js
shark help [COMMAND]
display help for shark
USAGE
$ shark help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
shark projects:create
create a project
USAGE
$ shark projects:create
OPTIONS
-d, --description=description The description of the project. (max 255 char)
-e, --environment=environment The environment of the project's resources. (development|staging|production)
-n, --name=name The human-readable name for the project. (unique) (max 175 char)
-p, --purpose=purpose The description of the project. (max 255 char)
See code: src/commands/projects/create.js
shark projects:list
list projects under your account
USAGE
$ shark projects:list
OPTIONS
-j, --json output in json format
-p, --page=page specific page to request
-x, --extended show extra columns
--columns=columns only show provided columns (comma-seperated)
--csv output is csv format
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort
See code: src/commands/projects/list.js
shark records:create
create a domain record
USAGE
$ shark records:create
OPTIONS
-D, --domain-name=domain-name The domain name
-P, --priority=priority The priority of the host (for SRV and MX records).
-T, --ttl=ttl This value is the time to live for the record, in seconds.
-d, --data=data The data for the record. For example, the 'data' for an 'A' record would be the IPv4
Address.
-j, --json output in json format
-n, --name=name The host name, alias, or service being defined by the record.
-p, --port=port The port that the service is accessible on (for SRV records only).
-t, --type=type The type of the record (A, MX, CNAME, etc).
--tag=tag The parameter tag for CAA records. Valid values are "issue", "issuewild", or "iodef"
See code: src/commands/records/create.js
shark records:delete
delete a domain record
USAGE
$ shark records:delete
OPTIONS
-i, --id=id domain record ID
-n, --name=name domain name
See code: src/commands/records/delete.js
shark records:list
list domain records
USAGE
$ shark records:list
OPTIONS
-j, --json output in json format
-n, --name=name domain name
-p, --page=page specific page to request
-x, --extended show extra columns
--columns=columns only show provided columns (comma-seperated)
--csv output is csv format
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort
See code: src/commands/records/list.js
shark snapshots:delete
delete a snapshot
USAGE
$ shark snapshots:delete
OPTIONS
-i, --id=id pass the id of the droplet
DESCRIPTION
Examples:
delete a snapshot:
shark snapshots:delete --id 123456
See code: src/commands/snapshots/delete.js
shark snapshots:get
get details about a snapshot
USAGE
$ shark snapshots:get
OPTIONS
-i, --id=id pass the action id
--json output in json format
See code: src/commands/snapshots/get.js
shark snapshots:list
list all snapshots
USAGE
$ shark snapshots:list
OPTIONS
-d, --droplets list all droplet snapshots
-j, --json output in json format
-p, --page=page specific page to request
-v, --volumes list all volumes snapshots
-x, --extended show extra columns
--columns=columns only show provided columns (comma-seperated)
--csv output is csv format
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort
See code: src/commands/snapshots/list.js
shark ssh_keys:create
add new SSH key in your account
USAGE
$ shark ssh_keys:create
OPTIONS
-j, --json Output in json format
-k, --key=key A string containing the entire public key
-n, --name=name The name to give to the new SSH key in your account
See code: src/commands/ssh_keys/create.js
shark ssh_keys:delete
remove ssh_key from your account
USAGE
$ shark ssh_keys:delete
OPTIONS
-f, --fingerprint=fingerprint use fingerprint of the key to delete
-i, --id=id use id of the key to delete
See code: src/commands/ssh_keys/delete.js
shark ssh_keys:get
get public_key by id/fingerprint
USAGE
$ shark ssh_keys:get
OPTIONS
-f, --fingerprint=fingerprint get ssh_key by fingerprint
-i, --id=id get ssh_key by id
-j, --json output in json format
See code: src/commands/ssh_keys/get.js
shark ssh_keys:list
list all SSH Keys under your account
USAGE
$ shark ssh_keys:list
OPTIONS
-j, --json output in json format
-p, --page=page specific page to request
-t, --tag=tag pass tag name to retrieve keys associated with the tag
-x, --extended show extra columns
--columns=columns only show provided columns (comma-seperated)
--csv output is csv format
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort
See code: src/commands/ssh_keys/list.js
shark token:delete
Delete previously set access token
USAGE
$ shark token:delete
See code: src/commands/token/delete.js
shark volumes:attach
attach a volume to a droplet (action)
USAGE
$ shark volumes:attach
OPTIONS
-d, --droplet-id=droplet-id (required) droplet ID
-i, --id=id (required) volume ID
-j, --json output in json format
-r, --region=region region of the volume
See code: src/commands/volumes/attach.js
shark volumes:create
create a volume
USAGE
$ shark volumes:create
OPTIONS
-P, --no-prompts disable interactive prompts
-S, --snap-id=snap-id provide snapshot_id to create a volume using the snapshot
-d, --desc=desc optional discription
-f, --fs-type=fs-type provide filesystem_type to format the volume ("ext4" or "xfs")
-j, --json output in json format
-l, --fs-label=fs-label The label to be applied to the filesystem
-n, --name=name (required) name for the volume
-r, --region=region (required) region for the volume ex: blr1
-s, --size=size (required) size of the volume in GiB
-t, --tags=tags tags to apply to the volume (new or existing)
See code: src/commands/volumes/create.js
shark volumes:delete
delete a volume
USAGE
$ shark volumes:delete
OPTIONS
-P, --no-prompts disable interactive prompts
-i, --id=id id of the volume
-j, --json output in json format
See code: src/commands/volumes/delete.js
shark volumes:detach
detach a volume from a droplet (action)
USAGE
$ shark volumes:detach
OPTIONS
-d, --droplet-id=droplet-id (required) droplet ID
-i, --id=id (required) volume ID
-j, --json output in json format
-r, --region=region region of the volume
See code: src/commands/volumes/detach.js
shark volumes:get
get details of specific volume
USAGE
$ shark volumes:get
OPTIONS
-P, --no-prompts disable interactive prompts
-i, --id=id id of the volume
-j, --json output in json format
See code: src/commands/volumes/get.js
shark volumes:list
list volumes
USAGE
$ shark volumes:list
OPTIONS
-j, --json output in json format
-p, --page=page specific page to request
-x, --extended show extra columns
--columns=columns only show provided columns (comma-seperated)
--csv output is csv format
--filter=filter filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--sort=sort
See code: src/commands/volumes/list.js
Contribute
- Fork this project
- Create a new branch related to the bug/feature
- Write tests where necessary
- Open a pull request and be proud
New to Open-source? Learn how to contribute here.
Credits
- Aleafs - For donating npm package name
shark
- Packages Contributors
License
MIT © Satya Rohith