Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix formatting in CLI design doc #1934

Merged
merged 1 commit into from
Oct 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 29 additions & 28 deletions docs/design-documents/20241024-conduit-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,14 +214,15 @@ It requires the pipeline id as argument.

#### Arguments

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| id | pipeline id to describe | Yes | |
| Name | Description | Required | Default Value |
|------|-------------------------|----------|---------------|
| id | pipeline id to describe | Yes | |

#### Flags

| Name | Description | Required | Default Value |
| grpc.address | address for serving the gRPC API | No | ":8084" |
| Name | Description | Required | Default Value |
|--------------|----------------------------------|----------|---------------|
| grpc.address | address for serving the gRPC API | No | ":8084" |

#### `--help`

Expand Down Expand Up @@ -269,15 +270,15 @@ It requires having Conduit previously running.

#### Arguments

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| id | connector id to describe | Yes | |
| Name | Description | Required | Default Value |
|------|--------------------------|----------|---------------|
| id | connector id to describe | Yes | |

#### Flags

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| grpc.address | address for serving the gRPC API | No | ":8084" |
| Name | Description | Required | Default Value |
|--------------|----------------------------------|----------|---------------|
| grpc.address | address for serving the gRPC API | No | ":8084" |

#### `--help`

Expand Down Expand Up @@ -314,9 +315,9 @@ It does not require having Conduit previously running.

#### Arguments

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| PLUGIN | connector plugin to describe | Yes | |
| Name | Description | Required | Default Value |
|--------|------------------------------|----------|---------------|
| PLUGIN | connector plugin to describe | Yes | |

#### `--help`

Expand All @@ -338,9 +339,9 @@ It requires having Conduit previously running.

#### Flags

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| grpc.address | address for serving the gRPC API | No | ":8084" |
| Name | Description | Required | Default Value |
|--------------|----------------------------------|----------|---------------|
| grpc.address | address for serving the gRPC API | No | ":8084" |

#### `--help`

Expand All @@ -360,9 +361,9 @@ It requires having Conduit previously running.

#### Arguments

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| id | processor ID | Yes | |
| Name | Description | Required | Default Value |
|------|--------------|----------|---------------|
| id | processor ID | Yes | |

#### `--help`

Expand Down Expand Up @@ -400,9 +401,9 @@ It does not require having Conduit previously running.

#### Arguments

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| plugin | processor plugin name | Yes | |
| Name | Description | Required | Default Value |
|--------|-----------------------|----------|---------------|
| plugin | processor plugin name | Yes | |

#### `--help`

Expand Down Expand Up @@ -435,8 +436,8 @@ conduit version

#### Global flags

| Name | Description | Required | Default Value |
|------|-------------|----------|---------------|
| config.path | path to the Conduit working environment | No | `.` |
| json | output json | No | |
| version | prints current Conduit version (alias to `conduit version`) | No | |
| Name | Description | Required | Default Value |
|-------------|-------------------------------------------------------------|----------|---------------|
| config.path | path to the Conduit working environment | No | `.` |
| json | output json | No | |
| version | prints current Conduit version (alias to `conduit version`) | No | |