Skip to content

Commit

Permalink
update markdown docs for new global args
Browse files Browse the repository at this point in the history
Signed-off-by: Marques Johansson <[email protected]>
  • Loading branch information
displague committed Sep 2, 2020
1 parent 69da67e commit ce7685b
Show file tree
Hide file tree
Showing 66 changed files with 337 additions and 113 deletions.
8 changes: 6 additions & 2 deletions docs/packet.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,12 @@ Command line interface for Packet Host
### Options

```
--config string Path to JSON or YAML configuration file
-h, --help help for packet
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
-h, --help help for packet
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_2fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ Two Factor Authentication operations: enable, disable, receive
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_2fa_disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@ packet 2fa disable [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_2fa_enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,11 @@ packet 2fa enable [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_2fa_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,11 @@ packet 2fa receive [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_capacity.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ Capacities operations: get, check
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
8 changes: 5 additions & 3 deletions docs/packet_capacity_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,18 @@ packet capacity check [flags]
```
-f, --facility string Code of the facility
-h, --help help for check
-j, --json JSON output
-p, --plan string Name of the plan
-q, --quantity int Number of devices wanted
-y, --yaml YAML output
```

### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
8 changes: 5 additions & 3 deletions docs/packet_capacity_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,16 @@ packet capacity get [flags]

```
-h, --help help for get
-j, --json JSON output
-y, --yaml YAML output
```

### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_device.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ Device operations: create, delete, update, start/stop, reboot and get.
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
8 changes: 5 additions & 3 deletions docs/packet_device_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ packet device create [flags]
-h, --help help for create
-H, --hostname string Hostname
-i, --ipxe-script-url string URL to the iPXE script
-j, --json JSON output
-o, --operating-system string Operating system name for the device
-P, --plan string Name of the plan
-p, --project-id string UUID of the project where the device will be created
Expand All @@ -36,13 +35,16 @@ packet device create [flags]
-t, --tags strings Tags for the device: --tags="tag1,tag2"
-T, --termination-time string Device termination time: --termination-time="15:04:05"
-u, --userdata string User data
-y, --yaml YAML output
```

### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_device_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ packet device delete [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
8 changes: 5 additions & 3 deletions docs/packet_device_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,17 @@ packet device get [flags]
```
-h, --help help for get
-i, --id string UUID of the device
-j, --json JSON output
-p, --project-id string UUID of the project
-y, --yaml YAML output
```

### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_device_reboot.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ packet device reboot [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_device_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ packet device start [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_device_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ packet device stop [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_device_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ packet device update [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ Events operations: get
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
10 changes: 7 additions & 3 deletions docs/packet_event_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ packet event get -d [device_UUID]
Retrieve all events of a current user:
packet event get

When using "--json" or "--yaml", "--include=relationships" is implied.


```
packet event get [flags]
Expand All @@ -34,16 +36,18 @@ packet event get [flags]
-d, --device-id string UUID of the device
-h, --help help for get
-i, --id string UUID of the event
-j, --json JSON output
-o, --organization-id string UUID of the organization
-p, --project-id string UUID of the project
-y, --yaml YAML output
```

### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_facilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ Facility operations: get
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
8 changes: 5 additions & 3 deletions docs/packet_facilities_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,16 @@ packet facilities get [flags]

```
-h, --help help for get
-j, --json -j or --json JSON output
-y, --yaml -y or --yaml YAML output
```

### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_hardware-reservation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ Hardware reservation operations: get, move
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
10 changes: 7 additions & 3 deletions docs/packet_hardware-reservation_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Example:

Retrieve all hardware reservations of a project:
packet hardware_reservations get -p [project_id]

When using "--json" or "--yaml", "--include=project,facility,device" is implied.


```
Expand All @@ -19,15 +21,17 @@ packet hardware-reservation get [flags]
```
-h, --help help for get
-i, --id string UUID of the hardware reservation
-j, --json JSON output
-p, --project-id string UUID of the project
-y, --yaml YAML output
```

### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_hardware-reservation_move.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ packet hardware-reservation move [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
6 changes: 5 additions & 1 deletion docs/packet_ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ IP address, reservations and assignment operations: assign, unassign, remove, av
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file
--exclude strings Comma seperated Href references to collapse in results, may be dotted three levels deep
--include strings Comma seperated Href references to expand in results, may be dotted three levels deep
-j, --json JSON output
-y, --yaml YAML output
```

### SEE ALSO
Expand Down
Loading

0 comments on commit ce7685b

Please sign in to comment.