shark
=====

A CLI to interact with digitalocean

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/shark.svg)](https://npmjs.org/package/shark)
[![Downloads/week](https://img.shields.io/npm/dw/shark.svg)](https://npmjs.org/package/shark)
[![License](https://img.shields.io/npm/l/shark.svg)](https://github.com/satyarohith/shark/blob/master/package.json)
[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
[![Known Vulnerabilities](https://snyk.io/test/github/satyarohith/shark/badge.svg?targetFile=package.json)](https://snyk.io/test/github/satyarohith/shark?targetFile=package.json)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
* [Contribute](#contribute)
* [Credits](#credits)
* [License](#license)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`shark actions:get`](#shark-actionsget)
* [`shark actions:list`](#shark-actionslist)
* [`shark domains`](#shark-domains)
* [`shark domains:create`](#shark-domainscreate)
* [`shark domains:delete`](#shark-domainsdelete)
* [`shark domains:list`](#shark-domainslist)
* [`shark droplets:backups`](#shark-dropletsbackups)
* [`shark droplets:create`](#shark-dropletscreate)
* [`shark droplets:delete`](#shark-dropletsdelete)
* [`shark droplets:list`](#shark-dropletslist)
* [`shark droplets:password`](#shark-dropletspassword)
* [`shark droplets:power`](#shark-dropletspower)
* [`shark droplets:shutdown`](#shark-dropletsshutdown)
* [`shark droplets:snapshot`](#shark-dropletssnapshot)
* [`shark help [COMMAND]`](#shark-help-command)
* [`shark projects:create`](#shark-projectscreate)
* [`shark projects:list`](#shark-projectslist)
* [`shark records:create`](#shark-recordscreate)
* [`shark records:delete`](#shark-recordsdelete)
* [`shark records:list`](#shark-recordslist)
* [`shark snapshots:delete`](#shark-snapshotsdelete)
* [`shark snapshots:get`](#shark-snapshotsget)
* [`shark snapshots:list`](#shark-snapshotslist)
* [`shark ssh_keys:create`](#shark-ssh_keyscreate)
* [`shark ssh_keys:delete`](#shark-ssh_keysdelete)
* [`shark ssh_keys:get`](#shark-ssh_keysget)
* [`shark ssh_keys:list`](#shark-ssh_keyslist)
* [`shark token:delete`](#shark-tokendelete)
* [`shark volumes:attach`](#shark-volumesattach)
* [`shark volumes:create`](#shark-volumescreate)
* [`shark volumes:delete`](#shark-volumesdelete)
* [`shark volumes:detach`](#shark-volumesdetach)
* [`shark volumes:get`](#shark-volumesget)
* [`shark volumes:list`](#shark-volumeslist)

## `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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/src/commands/actions/list.js)_

## `shark domains`

perform domain related operations

```
USAGE
  $ shark domains
```

_See code: [src/commands/domains/index.js](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/oclif/plugin-help/blob/v2.2.0/src/commands/help.ts)_

## `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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/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](https://github.com/satyarohith/shark/blob/v2.3.0/src/commands/volumes/list.js)_
<!-- commandsstop -->

# Contribute

1. Fork this project
2. Create a new branch related to the bug/feature
3. Write tests where necessary
4. Open a pull request and be proud

New to Open-source? Learn how to contribute [here](https://opensource.guide/how-to-contribute/).

# Credits

* [Aleafs](https://github.com/aleafs) - For donating npm package name `shark`
* [Packages Contributors](https://github.com/satyarohith/shark/network/dependencies)

# License

MIT © [Satya Rohith](https://satyarohith.com)