Skip to content

Commit

Permalink
[DOC]Add missing pachctl docs (#3878)
Browse files Browse the repository at this point in the history
* Changed pachctl.rst to index.rst
* Added pachctl docs
* Added missing files
  • Loading branch information
svekars committed Jul 1, 2019
1 parent 2ed0b38 commit 88fdd69
Show file tree
Hide file tree
Showing 137 changed files with 450 additions and 390 deletions.
15 changes: 15 additions & 0 deletions doc/pachctl/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@ This document describes Pachyderm Command Line Interface (CLI) tool
pachctl_auth_use-auth-token.md
pachctl_auth_whoami.md
pachctl_completion.md
pachctl_config.md
pachctl_config_delete.md
pachctl_config_delete_context.md
pachctl_config_get.md
pachctl_config_get_active-context.md
pachctl_config_get_context.md
pachctl_config_get_metrics.md
pachctl_config_list.md
pachctl_config_list_context.md
pachctl_config_set.md
pachctl_config_set_active-context.md
pachctl_config_set_context.md
pachctl_config_set_metrics.md
pachctl_config_update.md
pachctl_config_update_context.md
pachctl_copy.md
pachctl_copy_file.md
pachctl_create.md
Expand Down
27 changes: 12 additions & 15 deletions doc/pachctl/pachctl.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,23 @@
# pachctl
## pachctl

`pachctl` is the command line interface for Pachyderm. To install `pachctl`, follow
the [Getting Started](../getting_started/local_installation.html) instructions.

## Synopsis

### Synopsis


Access the Pachyderm API.

Environment variables:
PACHD_ADDRESS=<host>:<port>, the pachd server to connect to (e.g. 127.0.0.1:30650).
PACH_CONFIG=<path>, the path where pachctl will attempt to load your pach config.
JAEGER_ENDPOINT=<host>:<port>, the Jaeger server to connect to, if PACH_TRACE is set
PACH_TRACE={true,false}, If true, and JAEGER_ENDPOINT is set, attach a
Jaeger trace to any outgoing RPCs

```bash
PACHD_ADDRESS=<host>:<port>, the pachd server to connect to (e.g. 127.0.0.1:30650).
PACH_CONFIG=<path>, the path where pachctl will attempt to load your pach config.
JAEGER_ENDPOINT=<host>:<port>, the Jaeger server to connect to, if PACH_TRACE is set
PACH_TRACE={true,false}, If true, and JAEGER_ENDPOINT is set, attach a
Jaeger trace to any outgoing RPCs
```

## Options
### Options

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ Auth commands manage access to data in a Pachyderm cluster
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_activate.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ pachctl auth activate
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pachctl auth check (none|reader|writer|owner) <repo>
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_deactivate.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pachctl auth deactivate
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_get-auth-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ pachctl auth get-auth-token <username>
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_get-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ pachctl auth get-config
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pachctl auth get [<username>] <repo>
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_list-admins.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pachctl auth list-admins
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_login.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ pachctl auth login
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_logout.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pachctl auth logout
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_modify-admins.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ pachctl auth modify-admins
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_set-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ pachctl auth set-config
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_set.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pachctl auth set <username> (none|reader|writer|owner) <repo>
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_use-auth-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pachctl auth use-auth-token
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_auth_whoami.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ pachctl auth whoami
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

4 changes: 1 addition & 3 deletions doc/pachctl/pachctl_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ pachctl completion
### Options inherited from parent commands

```
--no-metrics Don't report user metrics for this command
--no-port-forwarding Disable implicit port forwarding
-v, --verbose Output verbose logs
-v, --verbose Output verbose logs
```

15 changes: 15 additions & 0 deletions doc/pachctl/pachctl_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## pachctl config

Manages the pachyderm config.

### Synopsis


Gets/sets pachyderm config values.

### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

15 changes: 15 additions & 0 deletions doc/pachctl/pachctl_config_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## pachctl config delete



### Synopsis




### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

19 changes: 19 additions & 0 deletions doc/pachctl/pachctl_config_delete_context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## pachctl config delete context

Deletes a context.

### Synopsis


Deletes a context.

```
pachctl config delete context
```

### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

15 changes: 15 additions & 0 deletions doc/pachctl/pachctl_config_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## pachctl config get



### Synopsis




### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

19 changes: 19 additions & 0 deletions doc/pachctl/pachctl_config_get_active-context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## pachctl config get active-context

Gets the currently active context.

### Synopsis


Gets the currently active context.

```
pachctl config get active-context
```

### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

19 changes: 19 additions & 0 deletions doc/pachctl/pachctl_config_get_context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## pachctl config get context

Gets a context.

### Synopsis


Gets the config of a context by its name.

```
pachctl config get context
```

### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

19 changes: 19 additions & 0 deletions doc/pachctl/pachctl_config_get_metrics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## pachctl config get metrics

Gets whether metrics are enabled.

### Synopsis


Gets whether metrics are enabled.

```
pachctl config get metrics
```

### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

15 changes: 15 additions & 0 deletions doc/pachctl/pachctl_config_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## pachctl config list



### Synopsis




### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

19 changes: 19 additions & 0 deletions doc/pachctl/pachctl_config_list_context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## pachctl config list context

Lists contexts.

### Synopsis


Lists contexts.

```
pachctl config list context
```

### Options inherited from parent commands

```
-v, --verbose Output verbose logs
```

0 comments on commit 88fdd69

Please sign in to comment.