From 3084563aea12aa19f406f1bf729baed8c4faa4f0 Mon Sep 17 00:00:00 2001 From: Taron Foxworth Date: Wed, 14 Apr 2021 11:13:18 -0400 Subject: [PATCH 1/4] update gen-docs to include frontmatter --- docs/cmd/meroxa.md | 37 +++++++++++++++----------- docs/cmd/meroxa_add.md | 11 ++++++-- docs/cmd/meroxa_add_resource.md | 9 ++++++- docs/cmd/meroxa_api.md | 9 ++++++- docs/cmd/meroxa_billing.md | 9 ++++++- docs/cmd/meroxa_completion.md | 9 ++++++- docs/cmd/meroxa_connect.md | 9 ++++++- docs/cmd/meroxa_create.md | 15 ++++++++--- docs/cmd/meroxa_create_connector.md | 9 ++++++- docs/cmd/meroxa_create_endpoint.md | 9 ++++++- docs/cmd/meroxa_create_pipeline.md | 9 ++++++- docs/cmd/meroxa_describe.md | 15 ++++++++--- docs/cmd/meroxa_describe_connector.md | 9 ++++++- docs/cmd/meroxa_describe_endpoint.md | 9 ++++++- docs/cmd/meroxa_describe_resource.md | 9 ++++++- docs/cmd/meroxa_list.md | 21 ++++++++++----- docs/cmd/meroxa_list_connectors.md | 9 ++++++- docs/cmd/meroxa_list_endpoint.md | 9 ++++++- docs/cmd/meroxa_list_pipelines.md | 9 ++++++- docs/cmd/meroxa_list_resource-types.md | 9 ++++++- docs/cmd/meroxa_list_resources.md | 9 ++++++- docs/cmd/meroxa_list_transforms.md | 9 ++++++- docs/cmd/meroxa_login.md | 9 ++++++- docs/cmd/meroxa_logout.md | 9 ++++++- docs/cmd/meroxa_logs.md | 11 ++++++-- docs/cmd/meroxa_logs_connector.md | 9 ++++++- docs/cmd/meroxa_open.md | 11 ++++++-- docs/cmd/meroxa_open_billing.md | 9 ++++++- docs/cmd/meroxa_remove.md | 17 ++++++++---- docs/cmd/meroxa_remove_connector.md | 9 ++++++- docs/cmd/meroxa_remove_endpoint.md | 9 ++++++- docs/cmd/meroxa_remove_pipeline.md | 9 ++++++- docs/cmd/meroxa_remove_resource.md | 9 ++++++- docs/cmd/meroxa_update.md | 15 ++++++++--- docs/cmd/meroxa_update_connector.md | 9 ++++++- docs/cmd/meroxa_update_pipeline.md | 9 ++++++- docs/cmd/meroxa_update_resource.md | 9 ++++++- docs/cmd/meroxa_version.md | 9 ++++++- gen-docs/main.go | 29 +++++++++++++++++++- 39 files changed, 368 insertions(+), 75 deletions(-) diff --git a/docs/cmd/meroxa.md b/docs/cmd/meroxa.md index 4cf0f9259..6c1f4bf86 100644 --- a/docs/cmd/meroxa.md +++ b/docs/cmd/meroxa.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa" +slug: meroxa +url: /cli/meroxa/ +--- ## meroxa The Meroxa CLI @@ -24,19 +31,19 @@ meroxa list resource-types ### SEE ALSO -* [meroxa add](meroxa_add.md) - Add a resource to your Meroxa resource catalog -* [meroxa api](meroxa_api.md) - Invoke Meroxa API -* [meroxa billing](meroxa_billing.md) - Open your billing page in a web browser -* [meroxa completion](meroxa_completion.md) - Generate completion script -* [meroxa connect](meroxa_connect.md) - Connect two resources together -* [meroxa create](meroxa_create.md) - Create Meroxa pipeline components -* [meroxa describe](meroxa_describe.md) - Describe a component -* [meroxa list](meroxa_list.md) - List components -* [meroxa login](meroxa_login.md) - login or sign up to the Meroxa platform -* [meroxa logout](meroxa_logout.md) - logout of the Meroxa platform -* [meroxa logs](meroxa_logs.md) - Print logs for a component -* [meroxa open](meroxa_open.md) - Open in a web browser -* [meroxa remove](meroxa_remove.md) - Remove a component -* [meroxa update](meroxa_update.md) - Update a component -* [meroxa version](meroxa_version.md) - Display the Meroxa CLI version +* [meroxa add](meroxa_add) - Add a resource to your Meroxa resource catalog +* [meroxa api](meroxa_api) - Invoke Meroxa API +* [meroxa billing](meroxa_billing) - Open your billing page in a web browser +* [meroxa completion](meroxa_completion) - Generate completion script +* [meroxa connect](meroxa_connect) - Connect two resources together +* [meroxa create](meroxa_create) - Create Meroxa pipeline components +* [meroxa describe](meroxa_describe) - Describe a component +* [meroxa list](meroxa_list) - List components +* [meroxa login](meroxa_login) - login or sign up to the Meroxa platform +* [meroxa logout](meroxa_logout) - logout of the Meroxa platform +* [meroxa logs](meroxa_logs) - Print logs for a component +* [meroxa open](meroxa_open) - Open in a web browser +* [meroxa remove](meroxa_remove) - Remove a component +* [meroxa update](meroxa_update) - Update a component +* [meroxa version](meroxa_version) - Display the Meroxa CLI version diff --git a/docs/cmd/meroxa_add.md b/docs/cmd/meroxa_add.md index aef5a64d6..512b28c5c 100644 --- a/docs/cmd/meroxa_add.md +++ b/docs/cmd/meroxa_add.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa add" +slug: meroxa_add +url: /cli/meroxa_add/ +--- ## meroxa add Add a resource to your Meroxa resource catalog @@ -19,6 +26,6 @@ Add a resource to your Meroxa resource catalog ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI -* [meroxa add resource](meroxa_add_resource.md) - Add a resource to your Meroxa resource catalog +* [meroxa](meroxa) - The Meroxa CLI +* [meroxa add resource](meroxa_add_resource) - Add a resource to your Meroxa resource catalog diff --git a/docs/cmd/meroxa_add_resource.md b/docs/cmd/meroxa_add_resource.md index a92c15aa7..ea96f2d5e 100644 --- a/docs/cmd/meroxa_add_resource.md +++ b/docs/cmd/meroxa_add_resource.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa add resource" +slug: meroxa_add_resource +url: /cli/meroxa_add_resource/ +--- ## meroxa add resource Add a resource to your Meroxa resource catalog @@ -42,5 +49,5 @@ meroxa add resource slack --type url -u $WEBHOOK_URL ### SEE ALSO -* [meroxa add](meroxa_add.md) - Add a resource to your Meroxa resource catalog +* [meroxa add](meroxa_add) - Add a resource to your Meroxa resource catalog diff --git a/docs/cmd/meroxa_api.md b/docs/cmd/meroxa_api.md index c54f026dc..43f71bd93 100644 --- a/docs/cmd/meroxa_api.md +++ b/docs/cmd/meroxa_api.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa api" +slug: meroxa_api +url: /cli/meroxa_api/ +--- ## meroxa api Invoke Meroxa API @@ -31,5 +38,5 @@ meroxa api POST /v1/endpoints '{"protocol": "HTTP", "stream": "resource-2-499379 ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa](meroxa) - The Meroxa CLI diff --git a/docs/cmd/meroxa_billing.md b/docs/cmd/meroxa_billing.md index 8174152d1..73491354e 100644 --- a/docs/cmd/meroxa_billing.md +++ b/docs/cmd/meroxa_billing.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa billing" +slug: meroxa_billing +url: /cli/meroxa_billing/ +--- ## meroxa billing Open your billing page in a web browser @@ -23,5 +30,5 @@ meroxa billing [flags] ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa](meroxa) - The Meroxa CLI diff --git a/docs/cmd/meroxa_completion.md b/docs/cmd/meroxa_completion.md index ba3b44bb1..4f66d9a34 100644 --- a/docs/cmd/meroxa_completion.md +++ b/docs/cmd/meroxa_completion.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa completion" +slug: meroxa_completion +url: /cli/meroxa_completion/ +--- ## meroxa completion Generate completion script @@ -57,5 +64,5 @@ meroxa completion [bash|zsh|fish|powershell] ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa](meroxa) - The Meroxa CLI diff --git a/docs/cmd/meroxa_connect.md b/docs/cmd/meroxa_connect.md index 8802b37e4..cd1745c99 100644 --- a/docs/cmd/meroxa_connect.md +++ b/docs/cmd/meroxa_connect.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa connect" +slug: meroxa_connect +url: /cli/meroxa_connect/ +--- ## meroxa connect Connect two resources together @@ -43,5 +50,5 @@ meroxa connect --from RESOURCE-NAME --to RESOURCE-NAME [flags] ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa](meroxa) - The Meroxa CLI diff --git a/docs/cmd/meroxa_create.md b/docs/cmd/meroxa_create.md index 43e40fa41..8aaa28210 100644 --- a/docs/cmd/meroxa_create.md +++ b/docs/cmd/meroxa_create.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa create" +slug: meroxa_create +url: /cli/meroxa_create/ +--- ## meroxa create Create Meroxa pipeline components @@ -24,8 +31,8 @@ including connectors. ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI -* [meroxa create connector](meroxa_create_connector.md) - Create a connector -* [meroxa create endpoint](meroxa_create_endpoint.md) - Create an endpoint -* [meroxa create pipeline](meroxa_create_pipeline.md) - Create a pipeline +* [meroxa](meroxa) - The Meroxa CLI +* [meroxa create connector](meroxa_create_connector) - Create a connector +* [meroxa create endpoint](meroxa_create_endpoint) - Create an endpoint +* [meroxa create pipeline](meroxa_create_pipeline) - Create a pipeline diff --git a/docs/cmd/meroxa_create_connector.md b/docs/cmd/meroxa_create_connector.md index 73be9c24f..6b07cd1b7 100644 --- a/docs/cmd/meroxa_create_connector.md +++ b/docs/cmd/meroxa_create_connector.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa create connector" +slug: meroxa_create_connector +url: /cli/meroxa_create_connector/ +--- ## meroxa create connector Create a connector @@ -41,5 +48,5 @@ meroxa create connector [NAME] --to pg2redshift --input orders --pipeline my-pip ### SEE ALSO -* [meroxa create](meroxa_create.md) - Create Meroxa pipeline components +* [meroxa create](meroxa_create) - Create Meroxa pipeline components diff --git a/docs/cmd/meroxa_create_endpoint.md b/docs/cmd/meroxa_create_endpoint.md index 0d5cc049b..c28086056 100644 --- a/docs/cmd/meroxa_create_endpoint.md +++ b/docs/cmd/meroxa_create_endpoint.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa create endpoint" +slug: meroxa_create_endpoint +url: /cli/meroxa_create_endpoint/ +--- ## meroxa create endpoint Create an endpoint @@ -36,5 +43,5 @@ meroxa create endpoint my-endpoint --protocol http --stream my-stream ### SEE ALSO -* [meroxa create](meroxa_create.md) - Create Meroxa pipeline components +* [meroxa create](meroxa_create) - Create Meroxa pipeline components diff --git a/docs/cmd/meroxa_create_pipeline.md b/docs/cmd/meroxa_create_pipeline.md index ad5eb253b..ef4038007 100644 --- a/docs/cmd/meroxa_create_pipeline.md +++ b/docs/cmd/meroxa_create_pipeline.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa create pipeline" +slug: meroxa_create_pipeline +url: /cli/meroxa_create_pipeline/ +--- ## meroxa create pipeline Create a pipeline @@ -24,5 +31,5 @@ meroxa create pipeline NAME [flags] ### SEE ALSO -* [meroxa create](meroxa_create.md) - Create Meroxa pipeline components +* [meroxa create](meroxa_create) - Create Meroxa pipeline components diff --git a/docs/cmd/meroxa_describe.md b/docs/cmd/meroxa_describe.md index d52211ee6..2077b2b09 100644 --- a/docs/cmd/meroxa_describe.md +++ b/docs/cmd/meroxa_describe.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa describe" +slug: meroxa_describe +url: /cli/meroxa_describe/ +--- ## meroxa describe Describe a component @@ -23,8 +30,8 @@ Describe a component of the Meroxa data platform, including resources and connec ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI -* [meroxa describe connector](meroxa_describe_connector.md) - Describe connector -* [meroxa describe endpoint](meroxa_describe_endpoint.md) - Describe endpoint -* [meroxa describe resource](meroxa_describe_resource.md) - Describe resource +* [meroxa](meroxa) - The Meroxa CLI +* [meroxa describe connector](meroxa_describe_connector) - Describe connector +* [meroxa describe endpoint](meroxa_describe_endpoint) - Describe endpoint +* [meroxa describe resource](meroxa_describe_resource) - Describe resource diff --git a/docs/cmd/meroxa_describe_connector.md b/docs/cmd/meroxa_describe_connector.md index eb4aa80ca..7473bdccd 100644 --- a/docs/cmd/meroxa_describe_connector.md +++ b/docs/cmd/meroxa_describe_connector.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa describe connector" +slug: meroxa_describe_connector +url: /cli/meroxa_describe_connector/ +--- ## meroxa describe connector Describe connector @@ -23,5 +30,5 @@ meroxa describe connector [name] [flags] ### SEE ALSO -* [meroxa describe](meroxa_describe.md) - Describe a component +* [meroxa describe](meroxa_describe) - Describe a component diff --git a/docs/cmd/meroxa_describe_endpoint.md b/docs/cmd/meroxa_describe_endpoint.md index 604cb6bdb..0d8aafde3 100644 --- a/docs/cmd/meroxa_describe_endpoint.md +++ b/docs/cmd/meroxa_describe_endpoint.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa describe endpoint" +slug: meroxa_describe_endpoint +url: /cli/meroxa_describe_endpoint/ +--- ## meroxa describe endpoint Describe endpoint @@ -23,5 +30,5 @@ meroxa describe endpoint NAME [flags] ### SEE ALSO -* [meroxa describe](meroxa_describe.md) - Describe a component +* [meroxa describe](meroxa_describe) - Describe a component diff --git a/docs/cmd/meroxa_describe_resource.md b/docs/cmd/meroxa_describe_resource.md index 70bbe7857..0a9108eae 100644 --- a/docs/cmd/meroxa_describe_resource.md +++ b/docs/cmd/meroxa_describe_resource.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa describe resource" +slug: meroxa_describe_resource +url: /cli/meroxa_describe_resource/ +--- ## meroxa describe resource Describe resource @@ -23,5 +30,5 @@ meroxa describe resource NAME [flags] ### SEE ALSO -* [meroxa describe](meroxa_describe.md) - Describe a component +* [meroxa describe](meroxa_describe) - Describe a component diff --git a/docs/cmd/meroxa_list.md b/docs/cmd/meroxa_list.md index 5b6f5b796..65954eee4 100644 --- a/docs/cmd/meroxa_list.md +++ b/docs/cmd/meroxa_list.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa list" +slug: meroxa_list +url: /cli/meroxa_list/ +--- ## meroxa list List components @@ -24,11 +31,11 @@ List the components of the Meroxa platform, including pipelines, ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI -* [meroxa list connectors](meroxa_list_connectors.md) - List connectors -* [meroxa list endpoint](meroxa_list_endpoint.md) - List endpoints -* [meroxa list pipelines](meroxa_list_pipelines.md) - List pipelines -* [meroxa list resource-types](meroxa_list_resource-types.md) - List resource-types -* [meroxa list resources](meroxa_list_resources.md) - List resources -* [meroxa list transforms](meroxa_list_transforms.md) - List transforms +* [meroxa](meroxa) - The Meroxa CLI +* [meroxa list connectors](meroxa_list_connectors) - List connectors +* [meroxa list endpoint](meroxa_list_endpoint) - List endpoints +* [meroxa list pipelines](meroxa_list_pipelines) - List pipelines +* [meroxa list resource-types](meroxa_list_resource-types) - List resource-types +* [meroxa list resources](meroxa_list_resources) - List resources +* [meroxa list transforms](meroxa_list_transforms) - List transforms diff --git a/docs/cmd/meroxa_list_connectors.md b/docs/cmd/meroxa_list_connectors.md index b7d608631..5d2598a33 100644 --- a/docs/cmd/meroxa_list_connectors.md +++ b/docs/cmd/meroxa_list_connectors.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa list connectors" +slug: meroxa_list_connectors +url: /cli/meroxa_list_connectors/ +--- ## meroxa list connectors List connectors @@ -24,5 +31,5 @@ meroxa list connectors [flags] ### SEE ALSO -* [meroxa list](meroxa_list.md) - List components +* [meroxa list](meroxa_list) - List components diff --git a/docs/cmd/meroxa_list_endpoint.md b/docs/cmd/meroxa_list_endpoint.md index a360991bd..e5c958172 100644 --- a/docs/cmd/meroxa_list_endpoint.md +++ b/docs/cmd/meroxa_list_endpoint.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa list endpoint" +slug: meroxa_list_endpoint +url: /cli/meroxa_list_endpoint/ +--- ## meroxa list endpoint List endpoints @@ -23,5 +30,5 @@ meroxa list endpoint [flags] ### SEE ALSO -* [meroxa list](meroxa_list.md) - List components +* [meroxa list](meroxa_list) - List components diff --git a/docs/cmd/meroxa_list_pipelines.md b/docs/cmd/meroxa_list_pipelines.md index 34424ea06..d2b087435 100644 --- a/docs/cmd/meroxa_list_pipelines.md +++ b/docs/cmd/meroxa_list_pipelines.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa list pipelines" +slug: meroxa_list_pipelines +url: /cli/meroxa_list_pipelines/ +--- ## meroxa list pipelines List pipelines @@ -23,5 +30,5 @@ meroxa list pipelines [flags] ### SEE ALSO -* [meroxa list](meroxa_list.md) - List components +* [meroxa list](meroxa_list) - List components diff --git a/docs/cmd/meroxa_list_resource-types.md b/docs/cmd/meroxa_list_resource-types.md index 81dabd8de..5c13ee250 100644 --- a/docs/cmd/meroxa_list_resource-types.md +++ b/docs/cmd/meroxa_list_resource-types.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa list resource-types" +slug: meroxa_list_resource-types +url: /cli/meroxa_list_resource-types/ +--- ## meroxa list resource-types List resource-types @@ -23,5 +30,5 @@ meroxa list resource-types [flags] ### SEE ALSO -* [meroxa list](meroxa_list.md) - List components +* [meroxa list](meroxa_list) - List components diff --git a/docs/cmd/meroxa_list_resources.md b/docs/cmd/meroxa_list_resources.md index 49c8b496c..ea76656f7 100644 --- a/docs/cmd/meroxa_list_resources.md +++ b/docs/cmd/meroxa_list_resources.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa list resources" +slug: meroxa_list_resources +url: /cli/meroxa_list_resources/ +--- ## meroxa list resources List resources @@ -23,5 +30,5 @@ meroxa list resources [flags] ### SEE ALSO -* [meroxa list](meroxa_list.md) - List components +* [meroxa list](meroxa_list) - List components diff --git a/docs/cmd/meroxa_list_transforms.md b/docs/cmd/meroxa_list_transforms.md index 61a7ff785..fd05cf680 100644 --- a/docs/cmd/meroxa_list_transforms.md +++ b/docs/cmd/meroxa_list_transforms.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa list transforms" +slug: meroxa_list_transforms +url: /cli/meroxa_list_transforms/ +--- ## meroxa list transforms List transforms @@ -23,5 +30,5 @@ meroxa list transforms [flags] ### SEE ALSO -* [meroxa list](meroxa_list.md) - List components +* [meroxa list](meroxa_list) - List components diff --git a/docs/cmd/meroxa_login.md b/docs/cmd/meroxa_login.md index ade0d6372..0f6f78679 100644 --- a/docs/cmd/meroxa_login.md +++ b/docs/cmd/meroxa_login.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa login" +slug: meroxa_login +url: /cli/meroxa_login/ +--- ## meroxa login login or sign up to the Meroxa platform @@ -23,5 +30,5 @@ meroxa login [flags] ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa](meroxa) - The Meroxa CLI diff --git a/docs/cmd/meroxa_logout.md b/docs/cmd/meroxa_logout.md index d82c29839..42d39c09a 100644 --- a/docs/cmd/meroxa_logout.md +++ b/docs/cmd/meroxa_logout.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa logout" +slug: meroxa_logout +url: /cli/meroxa_logout/ +--- ## meroxa logout logout of the Meroxa platform @@ -23,5 +30,5 @@ meroxa logout [flags] ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa](meroxa) - The Meroxa CLI diff --git a/docs/cmd/meroxa_logs.md b/docs/cmd/meroxa_logs.md index 51977caa8..af0495b39 100644 --- a/docs/cmd/meroxa_logs.md +++ b/docs/cmd/meroxa_logs.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa logs" +slug: meroxa_logs +url: /cli/meroxa_logs/ +--- ## meroxa logs Print logs for a component @@ -19,6 +26,6 @@ Print logs for a component ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI -* [meroxa logs connector](meroxa_logs_connector.md) - Print logs for a connector +* [meroxa](meroxa) - The Meroxa CLI +* [meroxa logs connector](meroxa_logs_connector) - Print logs for a connector diff --git a/docs/cmd/meroxa_logs_connector.md b/docs/cmd/meroxa_logs_connector.md index f5e79c07a..c28809ae7 100644 --- a/docs/cmd/meroxa_logs_connector.md +++ b/docs/cmd/meroxa_logs_connector.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa logs connector" +slug: meroxa_logs_connector +url: /cli/meroxa_logs_connector/ +--- ## meroxa logs connector Print logs for a connector @@ -23,5 +30,5 @@ meroxa logs connector NAME [flags] ### SEE ALSO -* [meroxa logs](meroxa_logs.md) - Print logs for a component +* [meroxa logs](meroxa_logs) - Print logs for a component diff --git a/docs/cmd/meroxa_open.md b/docs/cmd/meroxa_open.md index a1d1dbcd2..bfcb2d061 100644 --- a/docs/cmd/meroxa_open.md +++ b/docs/cmd/meroxa_open.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa open" +slug: meroxa_open +url: /cli/meroxa_open/ +--- ## meroxa open Open in a web browser @@ -19,6 +26,6 @@ Open in a web browser ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI -* [meroxa open billing](meroxa_open_billing.md) - Open your billing page in a web browser +* [meroxa](meroxa) - The Meroxa CLI +* [meroxa open billing](meroxa_open_billing) - Open your billing page in a web browser diff --git a/docs/cmd/meroxa_open_billing.md b/docs/cmd/meroxa_open_billing.md index 20cb1daaf..0da33fc78 100644 --- a/docs/cmd/meroxa_open_billing.md +++ b/docs/cmd/meroxa_open_billing.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa open billing" +slug: meroxa_open_billing +url: /cli/meroxa_open_billing/ +--- ## meroxa open billing Open your billing page in a web browser @@ -23,5 +30,5 @@ meroxa open billing [flags] ### SEE ALSO -* [meroxa open](meroxa_open.md) - Open in a web browser +* [meroxa open](meroxa_open) - Open in a web browser diff --git a/docs/cmd/meroxa_remove.md b/docs/cmd/meroxa_remove.md index f46ffa656..b86246f68 100644 --- a/docs/cmd/meroxa_remove.md +++ b/docs/cmd/meroxa_remove.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa remove" +slug: meroxa_remove +url: /cli/meroxa_remove/ +--- ## meroxa remove Remove a component @@ -25,9 +32,9 @@ Deprovision a component of the Meroxa platform, including pipelines, ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI -* [meroxa remove connector](meroxa_remove_connector.md) - Remove connector -* [meroxa remove endpoint](meroxa_remove_endpoint.md) - Remove endpoint -* [meroxa remove pipeline](meroxa_remove_pipeline.md) - Remove pipeline -* [meroxa remove resource](meroxa_remove_resource.md) - Remove resource +* [meroxa](meroxa) - The Meroxa CLI +* [meroxa remove connector](meroxa_remove_connector) - Remove connector +* [meroxa remove endpoint](meroxa_remove_endpoint) - Remove endpoint +* [meroxa remove pipeline](meroxa_remove_pipeline) - Remove pipeline +* [meroxa remove resource](meroxa_remove_resource) - Remove resource diff --git a/docs/cmd/meroxa_remove_connector.md b/docs/cmd/meroxa_remove_connector.md index 7cb3e4206..f475de325 100644 --- a/docs/cmd/meroxa_remove_connector.md +++ b/docs/cmd/meroxa_remove_connector.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa remove connector" +slug: meroxa_remove_connector +url: /cli/meroxa_remove_connector/ +--- ## meroxa remove connector Remove connector @@ -24,5 +31,5 @@ meroxa remove connector NAME [flags] ### SEE ALSO -* [meroxa remove](meroxa_remove.md) - Remove a component +* [meroxa remove](meroxa_remove) - Remove a component diff --git a/docs/cmd/meroxa_remove_endpoint.md b/docs/cmd/meroxa_remove_endpoint.md index 0e7da6acb..2d9585475 100644 --- a/docs/cmd/meroxa_remove_endpoint.md +++ b/docs/cmd/meroxa_remove_endpoint.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa remove endpoint" +slug: meroxa_remove_endpoint +url: /cli/meroxa_remove_endpoint/ +--- ## meroxa remove endpoint Remove endpoint @@ -24,5 +31,5 @@ meroxa remove endpoint NAME [flags] ### SEE ALSO -* [meroxa remove](meroxa_remove.md) - Remove a component +* [meroxa remove](meroxa_remove) - Remove a component diff --git a/docs/cmd/meroxa_remove_pipeline.md b/docs/cmd/meroxa_remove_pipeline.md index 709be5280..890cbcdc5 100644 --- a/docs/cmd/meroxa_remove_pipeline.md +++ b/docs/cmd/meroxa_remove_pipeline.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa remove pipeline" +slug: meroxa_remove_pipeline +url: /cli/meroxa_remove_pipeline/ +--- ## meroxa remove pipeline Remove pipeline @@ -24,5 +31,5 @@ meroxa remove pipeline NAME [flags] ### SEE ALSO -* [meroxa remove](meroxa_remove.md) - Remove a component +* [meroxa remove](meroxa_remove) - Remove a component diff --git a/docs/cmd/meroxa_remove_resource.md b/docs/cmd/meroxa_remove_resource.md index 04456a77a..3331ef51d 100644 --- a/docs/cmd/meroxa_remove_resource.md +++ b/docs/cmd/meroxa_remove_resource.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa remove resource" +slug: meroxa_remove_resource +url: /cli/meroxa_remove_resource/ +--- ## meroxa remove resource Remove resource @@ -24,5 +31,5 @@ meroxa remove resource NAME [flags] ### SEE ALSO -* [meroxa remove](meroxa_remove.md) - Remove a component +* [meroxa remove](meroxa_remove) - Remove a component diff --git a/docs/cmd/meroxa_update.md b/docs/cmd/meroxa_update.md index 348bb8b88..a32111d66 100644 --- a/docs/cmd/meroxa_update.md +++ b/docs/cmd/meroxa_update.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa update" +slug: meroxa_update +url: /cli/meroxa_update/ +--- ## meroxa update Update a component @@ -23,8 +30,8 @@ Update a component of the Meroxa platform, including connectors ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI -* [meroxa update connector](meroxa_update_connector.md) - Update connector state -* [meroxa update pipeline](meroxa_update_pipeline.md) - Update pipeline state -* [meroxa update resource](meroxa_update_resource.md) - Update a resource +* [meroxa](meroxa) - The Meroxa CLI +* [meroxa update connector](meroxa_update_connector) - Update connector state +* [meroxa update pipeline](meroxa_update_pipeline) - Update pipeline state +* [meroxa update resource](meroxa_update_resource) - Update a resource diff --git a/docs/cmd/meroxa_update_connector.md b/docs/cmd/meroxa_update_connector.md index 2118a2197..f0b1101df 100644 --- a/docs/cmd/meroxa_update_connector.md +++ b/docs/cmd/meroxa_update_connector.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa update connector" +slug: meroxa_update_connector +url: /cli/meroxa_update_connector/ +--- ## meroxa update connector Update connector state @@ -24,5 +31,5 @@ meroxa update connector NAME --state pause | resume | restart [flags] ### SEE ALSO -* [meroxa update](meroxa_update.md) - Update a component +* [meroxa update](meroxa_update) - Update a component diff --git a/docs/cmd/meroxa_update_pipeline.md b/docs/cmd/meroxa_update_pipeline.md index 89e8e8900..6fecf878c 100644 --- a/docs/cmd/meroxa_update_pipeline.md +++ b/docs/cmd/meroxa_update_pipeline.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa update pipeline" +slug: meroxa_update_pipeline +url: /cli/meroxa_update_pipeline/ +--- ## meroxa update pipeline Update pipeline state @@ -35,5 +42,5 @@ meroxa update pipeline pipeline-name --metadata '{"key":"value"}' ### SEE ALSO -* [meroxa update](meroxa_update.md) - Update a component +* [meroxa update](meroxa_update) - Update a component diff --git a/docs/cmd/meroxa_update_resource.md b/docs/cmd/meroxa_update_resource.md index 2f352292b..f9baaed4b 100644 --- a/docs/cmd/meroxa_update_resource.md +++ b/docs/cmd/meroxa_update_resource.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa update resource" +slug: meroxa_update_resource +url: /cli/meroxa_update_resource/ +--- ## meroxa update resource Update a resource @@ -31,5 +38,5 @@ meroxa update resource NAME [flags] ### SEE ALSO -* [meroxa update](meroxa_update.md) - Update a component +* [meroxa update](meroxa_update) - Update a component diff --git a/docs/cmd/meroxa_version.md b/docs/cmd/meroxa_version.md index 3901bae1e..c5a442c92 100644 --- a/docs/cmd/meroxa_version.md +++ b/docs/cmd/meroxa_version.md @@ -1,3 +1,10 @@ +--- +createdAt: 2021-04-14T11:12:19-04:00 +updatedAt: 2021-04-14T11:12:19-04:00 +title: "meroxa version" +slug: meroxa_version +url: /cli/meroxa_version/ +--- ## meroxa version Display the Meroxa CLI version @@ -23,5 +30,5 @@ meroxa version [flags] ### SEE ALSO -* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa](meroxa) - The Meroxa CLI diff --git a/gen-docs/main.go b/gen-docs/main.go index 2792d6dcc..3c9102024 100644 --- a/gen-docs/main.go +++ b/gen-docs/main.go @@ -1,14 +1,28 @@ package main import ( + "fmt" "log" "os" + "path" + "path/filepath" + "strings" + "time" cmd "github.com/meroxa/cli/cmd" "github.com/spf13/cobra/doc" ) +const fmTemplate = `--- +createdAt: %s +updatedAt: %s +title: "%s" +slug: %s +url: %s +--- +` + func main() { // set HOME env var so that default values involve user's home directory do not depend on the running user. os.Setenv("HOME", "/home/user") @@ -27,8 +41,21 @@ func main() { log.Fatal(err) } + filePrepender := func(filename string) string { + createdAt := time.Now().Format(time.RFC3339) + name := filepath.Base(filename) + base := strings.TrimSuffix(name, path.Ext(name)) + url := "/cli/" + strings.ToLower(base) + "/" + return fmt.Sprintf(fmTemplate, createdAt, createdAt, strings.Replace(base, "_", " ", -1), base, url) + } + + linkHandler := func(name string) string { + base := strings.TrimSuffix(name, path.Ext(name)) + return strings.ToLower(base) + } + // Generating Markdown Documents - err := doc.GenMarkdownTree(rootCmd, "./docs/cmd") + err := doc.GenMarkdownTreeCustom(rootCmd, "./docs/cmd", filePrepender, linkHandler) if err != nil { log.Fatal(err) } From 0a56fb0ef71ed6c3e21639646d59d8b83073bac2 Mon Sep 17 00:00:00 2001 From: Taron Foxworth Date: Wed, 14 Apr 2021 11:25:14 -0400 Subject: [PATCH 2/4] make docs/web for web version of docs --- docs/cmd/meroxa.md | 37 +++++++++-------------- docs/cmd/meroxa_add.md | 11 ++----- docs/cmd/meroxa_add_resource.md | 9 +----- docs/cmd/meroxa_api.md | 9 +----- docs/cmd/meroxa_billing.md | 9 +----- docs/cmd/meroxa_completion.md | 9 +----- docs/cmd/meroxa_connect.md | 9 +----- docs/cmd/meroxa_create.md | 15 +++------ docs/cmd/meroxa_create_connector.md | 9 +----- docs/cmd/meroxa_create_endpoint.md | 9 +----- docs/cmd/meroxa_create_pipeline.md | 9 +----- docs/cmd/meroxa_describe.md | 15 +++------ docs/cmd/meroxa_describe_connector.md | 9 +----- docs/cmd/meroxa_describe_endpoint.md | 9 +----- docs/cmd/meroxa_describe_resource.md | 9 +----- docs/cmd/meroxa_list.md | 21 +++++-------- docs/cmd/meroxa_list_connectors.md | 9 +----- docs/cmd/meroxa_list_endpoint.md | 9 +----- docs/cmd/meroxa_list_pipelines.md | 9 +----- docs/cmd/meroxa_list_resource-types.md | 9 +----- docs/cmd/meroxa_list_resources.md | 9 +----- docs/cmd/meroxa_list_transforms.md | 9 +----- docs/cmd/meroxa_login.md | 9 +----- docs/cmd/meroxa_logout.md | 9 +----- docs/cmd/meroxa_logs.md | 11 ++----- docs/cmd/meroxa_logs_connector.md | 9 +----- docs/cmd/meroxa_open.md | 11 ++----- docs/cmd/meroxa_open_billing.md | 9 +----- docs/cmd/meroxa_remove.md | 17 +++-------- docs/cmd/meroxa_remove_connector.md | 9 +----- docs/cmd/meroxa_remove_endpoint.md | 9 +----- docs/cmd/meroxa_remove_pipeline.md | 9 +----- docs/cmd/meroxa_remove_resource.md | 9 +----- docs/cmd/meroxa_update.md | 15 +++------ docs/cmd/meroxa_update_connector.md | 9 +----- docs/cmd/meroxa_update_pipeline.md | 9 +----- docs/cmd/meroxa_update_resource.md | 9 +----- docs/cmd/meroxa_version.md | 9 +----- gen-docs/main.go | 42 +++++++++++++++++++++++--- 39 files changed, 111 insertions(+), 345 deletions(-) diff --git a/docs/cmd/meroxa.md b/docs/cmd/meroxa.md index 6c1f4bf86..4cf0f9259 100644 --- a/docs/cmd/meroxa.md +++ b/docs/cmd/meroxa.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa" -slug: meroxa -url: /cli/meroxa/ ---- ## meroxa The Meroxa CLI @@ -31,19 +24,19 @@ meroxa list resource-types ### SEE ALSO -* [meroxa add](meroxa_add) - Add a resource to your Meroxa resource catalog -* [meroxa api](meroxa_api) - Invoke Meroxa API -* [meroxa billing](meroxa_billing) - Open your billing page in a web browser -* [meroxa completion](meroxa_completion) - Generate completion script -* [meroxa connect](meroxa_connect) - Connect two resources together -* [meroxa create](meroxa_create) - Create Meroxa pipeline components -* [meroxa describe](meroxa_describe) - Describe a component -* [meroxa list](meroxa_list) - List components -* [meroxa login](meroxa_login) - login or sign up to the Meroxa platform -* [meroxa logout](meroxa_logout) - logout of the Meroxa platform -* [meroxa logs](meroxa_logs) - Print logs for a component -* [meroxa open](meroxa_open) - Open in a web browser -* [meroxa remove](meroxa_remove) - Remove a component -* [meroxa update](meroxa_update) - Update a component -* [meroxa version](meroxa_version) - Display the Meroxa CLI version +* [meroxa add](meroxa_add.md) - Add a resource to your Meroxa resource catalog +* [meroxa api](meroxa_api.md) - Invoke Meroxa API +* [meroxa billing](meroxa_billing.md) - Open your billing page in a web browser +* [meroxa completion](meroxa_completion.md) - Generate completion script +* [meroxa connect](meroxa_connect.md) - Connect two resources together +* [meroxa create](meroxa_create.md) - Create Meroxa pipeline components +* [meroxa describe](meroxa_describe.md) - Describe a component +* [meroxa list](meroxa_list.md) - List components +* [meroxa login](meroxa_login.md) - login or sign up to the Meroxa platform +* [meroxa logout](meroxa_logout.md) - logout of the Meroxa platform +* [meroxa logs](meroxa_logs.md) - Print logs for a component +* [meroxa open](meroxa_open.md) - Open in a web browser +* [meroxa remove](meroxa_remove.md) - Remove a component +* [meroxa update](meroxa_update.md) - Update a component +* [meroxa version](meroxa_version.md) - Display the Meroxa CLI version diff --git a/docs/cmd/meroxa_add.md b/docs/cmd/meroxa_add.md index 512b28c5c..aef5a64d6 100644 --- a/docs/cmd/meroxa_add.md +++ b/docs/cmd/meroxa_add.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa add" -slug: meroxa_add -url: /cli/meroxa_add/ ---- ## meroxa add Add a resource to your Meroxa resource catalog @@ -26,6 +19,6 @@ Add a resource to your Meroxa resource catalog ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI -* [meroxa add resource](meroxa_add_resource) - Add a resource to your Meroxa resource catalog +* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa add resource](meroxa_add_resource.md) - Add a resource to your Meroxa resource catalog diff --git a/docs/cmd/meroxa_add_resource.md b/docs/cmd/meroxa_add_resource.md index ea96f2d5e..a92c15aa7 100644 --- a/docs/cmd/meroxa_add_resource.md +++ b/docs/cmd/meroxa_add_resource.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa add resource" -slug: meroxa_add_resource -url: /cli/meroxa_add_resource/ ---- ## meroxa add resource Add a resource to your Meroxa resource catalog @@ -49,5 +42,5 @@ meroxa add resource slack --type url -u $WEBHOOK_URL ### SEE ALSO -* [meroxa add](meroxa_add) - Add a resource to your Meroxa resource catalog +* [meroxa add](meroxa_add.md) - Add a resource to your Meroxa resource catalog diff --git a/docs/cmd/meroxa_api.md b/docs/cmd/meroxa_api.md index 43f71bd93..c54f026dc 100644 --- a/docs/cmd/meroxa_api.md +++ b/docs/cmd/meroxa_api.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa api" -slug: meroxa_api -url: /cli/meroxa_api/ ---- ## meroxa api Invoke Meroxa API @@ -38,5 +31,5 @@ meroxa api POST /v1/endpoints '{"protocol": "HTTP", "stream": "resource-2-499379 ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI +* [meroxa](meroxa.md) - The Meroxa CLI diff --git a/docs/cmd/meroxa_billing.md b/docs/cmd/meroxa_billing.md index 73491354e..8174152d1 100644 --- a/docs/cmd/meroxa_billing.md +++ b/docs/cmd/meroxa_billing.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa billing" -slug: meroxa_billing -url: /cli/meroxa_billing/ ---- ## meroxa billing Open your billing page in a web browser @@ -30,5 +23,5 @@ meroxa billing [flags] ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI +* [meroxa](meroxa.md) - The Meroxa CLI diff --git a/docs/cmd/meroxa_completion.md b/docs/cmd/meroxa_completion.md index 4f66d9a34..ba3b44bb1 100644 --- a/docs/cmd/meroxa_completion.md +++ b/docs/cmd/meroxa_completion.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa completion" -slug: meroxa_completion -url: /cli/meroxa_completion/ ---- ## meroxa completion Generate completion script @@ -64,5 +57,5 @@ meroxa completion [bash|zsh|fish|powershell] ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI +* [meroxa](meroxa.md) - The Meroxa CLI diff --git a/docs/cmd/meroxa_connect.md b/docs/cmd/meroxa_connect.md index cd1745c99..8802b37e4 100644 --- a/docs/cmd/meroxa_connect.md +++ b/docs/cmd/meroxa_connect.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa connect" -slug: meroxa_connect -url: /cli/meroxa_connect/ ---- ## meroxa connect Connect two resources together @@ -50,5 +43,5 @@ meroxa connect --from RESOURCE-NAME --to RESOURCE-NAME [flags] ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI +* [meroxa](meroxa.md) - The Meroxa CLI diff --git a/docs/cmd/meroxa_create.md b/docs/cmd/meroxa_create.md index 8aaa28210..43e40fa41 100644 --- a/docs/cmd/meroxa_create.md +++ b/docs/cmd/meroxa_create.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa create" -slug: meroxa_create -url: /cli/meroxa_create/ ---- ## meroxa create Create Meroxa pipeline components @@ -31,8 +24,8 @@ including connectors. ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI -* [meroxa create connector](meroxa_create_connector) - Create a connector -* [meroxa create endpoint](meroxa_create_endpoint) - Create an endpoint -* [meroxa create pipeline](meroxa_create_pipeline) - Create a pipeline +* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa create connector](meroxa_create_connector.md) - Create a connector +* [meroxa create endpoint](meroxa_create_endpoint.md) - Create an endpoint +* [meroxa create pipeline](meroxa_create_pipeline.md) - Create a pipeline diff --git a/docs/cmd/meroxa_create_connector.md b/docs/cmd/meroxa_create_connector.md index 6b07cd1b7..73be9c24f 100644 --- a/docs/cmd/meroxa_create_connector.md +++ b/docs/cmd/meroxa_create_connector.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa create connector" -slug: meroxa_create_connector -url: /cli/meroxa_create_connector/ ---- ## meroxa create connector Create a connector @@ -48,5 +41,5 @@ meroxa create connector [NAME] --to pg2redshift --input orders --pipeline my-pip ### SEE ALSO -* [meroxa create](meroxa_create) - Create Meroxa pipeline components +* [meroxa create](meroxa_create.md) - Create Meroxa pipeline components diff --git a/docs/cmd/meroxa_create_endpoint.md b/docs/cmd/meroxa_create_endpoint.md index c28086056..0d5cc049b 100644 --- a/docs/cmd/meroxa_create_endpoint.md +++ b/docs/cmd/meroxa_create_endpoint.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa create endpoint" -slug: meroxa_create_endpoint -url: /cli/meroxa_create_endpoint/ ---- ## meroxa create endpoint Create an endpoint @@ -43,5 +36,5 @@ meroxa create endpoint my-endpoint --protocol http --stream my-stream ### SEE ALSO -* [meroxa create](meroxa_create) - Create Meroxa pipeline components +* [meroxa create](meroxa_create.md) - Create Meroxa pipeline components diff --git a/docs/cmd/meroxa_create_pipeline.md b/docs/cmd/meroxa_create_pipeline.md index ef4038007..ad5eb253b 100644 --- a/docs/cmd/meroxa_create_pipeline.md +++ b/docs/cmd/meroxa_create_pipeline.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa create pipeline" -slug: meroxa_create_pipeline -url: /cli/meroxa_create_pipeline/ ---- ## meroxa create pipeline Create a pipeline @@ -31,5 +24,5 @@ meroxa create pipeline NAME [flags] ### SEE ALSO -* [meroxa create](meroxa_create) - Create Meroxa pipeline components +* [meroxa create](meroxa_create.md) - Create Meroxa pipeline components diff --git a/docs/cmd/meroxa_describe.md b/docs/cmd/meroxa_describe.md index 2077b2b09..d52211ee6 100644 --- a/docs/cmd/meroxa_describe.md +++ b/docs/cmd/meroxa_describe.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa describe" -slug: meroxa_describe -url: /cli/meroxa_describe/ ---- ## meroxa describe Describe a component @@ -30,8 +23,8 @@ Describe a component of the Meroxa data platform, including resources and connec ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI -* [meroxa describe connector](meroxa_describe_connector) - Describe connector -* [meroxa describe endpoint](meroxa_describe_endpoint) - Describe endpoint -* [meroxa describe resource](meroxa_describe_resource) - Describe resource +* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa describe connector](meroxa_describe_connector.md) - Describe connector +* [meroxa describe endpoint](meroxa_describe_endpoint.md) - Describe endpoint +* [meroxa describe resource](meroxa_describe_resource.md) - Describe resource diff --git a/docs/cmd/meroxa_describe_connector.md b/docs/cmd/meroxa_describe_connector.md index 7473bdccd..eb4aa80ca 100644 --- a/docs/cmd/meroxa_describe_connector.md +++ b/docs/cmd/meroxa_describe_connector.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa describe connector" -slug: meroxa_describe_connector -url: /cli/meroxa_describe_connector/ ---- ## meroxa describe connector Describe connector @@ -30,5 +23,5 @@ meroxa describe connector [name] [flags] ### SEE ALSO -* [meroxa describe](meroxa_describe) - Describe a component +* [meroxa describe](meroxa_describe.md) - Describe a component diff --git a/docs/cmd/meroxa_describe_endpoint.md b/docs/cmd/meroxa_describe_endpoint.md index 0d8aafde3..604cb6bdb 100644 --- a/docs/cmd/meroxa_describe_endpoint.md +++ b/docs/cmd/meroxa_describe_endpoint.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa describe endpoint" -slug: meroxa_describe_endpoint -url: /cli/meroxa_describe_endpoint/ ---- ## meroxa describe endpoint Describe endpoint @@ -30,5 +23,5 @@ meroxa describe endpoint NAME [flags] ### SEE ALSO -* [meroxa describe](meroxa_describe) - Describe a component +* [meroxa describe](meroxa_describe.md) - Describe a component diff --git a/docs/cmd/meroxa_describe_resource.md b/docs/cmd/meroxa_describe_resource.md index 0a9108eae..70bbe7857 100644 --- a/docs/cmd/meroxa_describe_resource.md +++ b/docs/cmd/meroxa_describe_resource.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa describe resource" -slug: meroxa_describe_resource -url: /cli/meroxa_describe_resource/ ---- ## meroxa describe resource Describe resource @@ -30,5 +23,5 @@ meroxa describe resource NAME [flags] ### SEE ALSO -* [meroxa describe](meroxa_describe) - Describe a component +* [meroxa describe](meroxa_describe.md) - Describe a component diff --git a/docs/cmd/meroxa_list.md b/docs/cmd/meroxa_list.md index 65954eee4..5b6f5b796 100644 --- a/docs/cmd/meroxa_list.md +++ b/docs/cmd/meroxa_list.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa list" -slug: meroxa_list -url: /cli/meroxa_list/ ---- ## meroxa list List components @@ -31,11 +24,11 @@ List the components of the Meroxa platform, including pipelines, ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI -* [meroxa list connectors](meroxa_list_connectors) - List connectors -* [meroxa list endpoint](meroxa_list_endpoint) - List endpoints -* [meroxa list pipelines](meroxa_list_pipelines) - List pipelines -* [meroxa list resource-types](meroxa_list_resource-types) - List resource-types -* [meroxa list resources](meroxa_list_resources) - List resources -* [meroxa list transforms](meroxa_list_transforms) - List transforms +* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa list connectors](meroxa_list_connectors.md) - List connectors +* [meroxa list endpoint](meroxa_list_endpoint.md) - List endpoints +* [meroxa list pipelines](meroxa_list_pipelines.md) - List pipelines +* [meroxa list resource-types](meroxa_list_resource-types.md) - List resource-types +* [meroxa list resources](meroxa_list_resources.md) - List resources +* [meroxa list transforms](meroxa_list_transforms.md) - List transforms diff --git a/docs/cmd/meroxa_list_connectors.md b/docs/cmd/meroxa_list_connectors.md index 5d2598a33..b7d608631 100644 --- a/docs/cmd/meroxa_list_connectors.md +++ b/docs/cmd/meroxa_list_connectors.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa list connectors" -slug: meroxa_list_connectors -url: /cli/meroxa_list_connectors/ ---- ## meroxa list connectors List connectors @@ -31,5 +24,5 @@ meroxa list connectors [flags] ### SEE ALSO -* [meroxa list](meroxa_list) - List components +* [meroxa list](meroxa_list.md) - List components diff --git a/docs/cmd/meroxa_list_endpoint.md b/docs/cmd/meroxa_list_endpoint.md index e5c958172..a360991bd 100644 --- a/docs/cmd/meroxa_list_endpoint.md +++ b/docs/cmd/meroxa_list_endpoint.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa list endpoint" -slug: meroxa_list_endpoint -url: /cli/meroxa_list_endpoint/ ---- ## meroxa list endpoint List endpoints @@ -30,5 +23,5 @@ meroxa list endpoint [flags] ### SEE ALSO -* [meroxa list](meroxa_list) - List components +* [meroxa list](meroxa_list.md) - List components diff --git a/docs/cmd/meroxa_list_pipelines.md b/docs/cmd/meroxa_list_pipelines.md index d2b087435..34424ea06 100644 --- a/docs/cmd/meroxa_list_pipelines.md +++ b/docs/cmd/meroxa_list_pipelines.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa list pipelines" -slug: meroxa_list_pipelines -url: /cli/meroxa_list_pipelines/ ---- ## meroxa list pipelines List pipelines @@ -30,5 +23,5 @@ meroxa list pipelines [flags] ### SEE ALSO -* [meroxa list](meroxa_list) - List components +* [meroxa list](meroxa_list.md) - List components diff --git a/docs/cmd/meroxa_list_resource-types.md b/docs/cmd/meroxa_list_resource-types.md index 5c13ee250..81dabd8de 100644 --- a/docs/cmd/meroxa_list_resource-types.md +++ b/docs/cmd/meroxa_list_resource-types.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa list resource-types" -slug: meroxa_list_resource-types -url: /cli/meroxa_list_resource-types/ ---- ## meroxa list resource-types List resource-types @@ -30,5 +23,5 @@ meroxa list resource-types [flags] ### SEE ALSO -* [meroxa list](meroxa_list) - List components +* [meroxa list](meroxa_list.md) - List components diff --git a/docs/cmd/meroxa_list_resources.md b/docs/cmd/meroxa_list_resources.md index ea76656f7..49c8b496c 100644 --- a/docs/cmd/meroxa_list_resources.md +++ b/docs/cmd/meroxa_list_resources.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa list resources" -slug: meroxa_list_resources -url: /cli/meroxa_list_resources/ ---- ## meroxa list resources List resources @@ -30,5 +23,5 @@ meroxa list resources [flags] ### SEE ALSO -* [meroxa list](meroxa_list) - List components +* [meroxa list](meroxa_list.md) - List components diff --git a/docs/cmd/meroxa_list_transforms.md b/docs/cmd/meroxa_list_transforms.md index fd05cf680..61a7ff785 100644 --- a/docs/cmd/meroxa_list_transforms.md +++ b/docs/cmd/meroxa_list_transforms.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa list transforms" -slug: meroxa_list_transforms -url: /cli/meroxa_list_transforms/ ---- ## meroxa list transforms List transforms @@ -30,5 +23,5 @@ meroxa list transforms [flags] ### SEE ALSO -* [meroxa list](meroxa_list) - List components +* [meroxa list](meroxa_list.md) - List components diff --git a/docs/cmd/meroxa_login.md b/docs/cmd/meroxa_login.md index 0f6f78679..ade0d6372 100644 --- a/docs/cmd/meroxa_login.md +++ b/docs/cmd/meroxa_login.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa login" -slug: meroxa_login -url: /cli/meroxa_login/ ---- ## meroxa login login or sign up to the Meroxa platform @@ -30,5 +23,5 @@ meroxa login [flags] ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI +* [meroxa](meroxa.md) - The Meroxa CLI diff --git a/docs/cmd/meroxa_logout.md b/docs/cmd/meroxa_logout.md index 42d39c09a..d82c29839 100644 --- a/docs/cmd/meroxa_logout.md +++ b/docs/cmd/meroxa_logout.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa logout" -slug: meroxa_logout -url: /cli/meroxa_logout/ ---- ## meroxa logout logout of the Meroxa platform @@ -30,5 +23,5 @@ meroxa logout [flags] ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI +* [meroxa](meroxa.md) - The Meroxa CLI diff --git a/docs/cmd/meroxa_logs.md b/docs/cmd/meroxa_logs.md index af0495b39..51977caa8 100644 --- a/docs/cmd/meroxa_logs.md +++ b/docs/cmd/meroxa_logs.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa logs" -slug: meroxa_logs -url: /cli/meroxa_logs/ ---- ## meroxa logs Print logs for a component @@ -26,6 +19,6 @@ Print logs for a component ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI -* [meroxa logs connector](meroxa_logs_connector) - Print logs for a connector +* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa logs connector](meroxa_logs_connector.md) - Print logs for a connector diff --git a/docs/cmd/meroxa_logs_connector.md b/docs/cmd/meroxa_logs_connector.md index c28809ae7..f5e79c07a 100644 --- a/docs/cmd/meroxa_logs_connector.md +++ b/docs/cmd/meroxa_logs_connector.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa logs connector" -slug: meroxa_logs_connector -url: /cli/meroxa_logs_connector/ ---- ## meroxa logs connector Print logs for a connector @@ -30,5 +23,5 @@ meroxa logs connector NAME [flags] ### SEE ALSO -* [meroxa logs](meroxa_logs) - Print logs for a component +* [meroxa logs](meroxa_logs.md) - Print logs for a component diff --git a/docs/cmd/meroxa_open.md b/docs/cmd/meroxa_open.md index bfcb2d061..a1d1dbcd2 100644 --- a/docs/cmd/meroxa_open.md +++ b/docs/cmd/meroxa_open.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa open" -slug: meroxa_open -url: /cli/meroxa_open/ ---- ## meroxa open Open in a web browser @@ -26,6 +19,6 @@ Open in a web browser ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI -* [meroxa open billing](meroxa_open_billing) - Open your billing page in a web browser +* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa open billing](meroxa_open_billing.md) - Open your billing page in a web browser diff --git a/docs/cmd/meroxa_open_billing.md b/docs/cmd/meroxa_open_billing.md index 0da33fc78..20cb1daaf 100644 --- a/docs/cmd/meroxa_open_billing.md +++ b/docs/cmd/meroxa_open_billing.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa open billing" -slug: meroxa_open_billing -url: /cli/meroxa_open_billing/ ---- ## meroxa open billing Open your billing page in a web browser @@ -30,5 +23,5 @@ meroxa open billing [flags] ### SEE ALSO -* [meroxa open](meroxa_open) - Open in a web browser +* [meroxa open](meroxa_open.md) - Open in a web browser diff --git a/docs/cmd/meroxa_remove.md b/docs/cmd/meroxa_remove.md index b86246f68..f46ffa656 100644 --- a/docs/cmd/meroxa_remove.md +++ b/docs/cmd/meroxa_remove.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa remove" -slug: meroxa_remove -url: /cli/meroxa_remove/ ---- ## meroxa remove Remove a component @@ -32,9 +25,9 @@ Deprovision a component of the Meroxa platform, including pipelines, ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI -* [meroxa remove connector](meroxa_remove_connector) - Remove connector -* [meroxa remove endpoint](meroxa_remove_endpoint) - Remove endpoint -* [meroxa remove pipeline](meroxa_remove_pipeline) - Remove pipeline -* [meroxa remove resource](meroxa_remove_resource) - Remove resource +* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa remove connector](meroxa_remove_connector.md) - Remove connector +* [meroxa remove endpoint](meroxa_remove_endpoint.md) - Remove endpoint +* [meroxa remove pipeline](meroxa_remove_pipeline.md) - Remove pipeline +* [meroxa remove resource](meroxa_remove_resource.md) - Remove resource diff --git a/docs/cmd/meroxa_remove_connector.md b/docs/cmd/meroxa_remove_connector.md index f475de325..7cb3e4206 100644 --- a/docs/cmd/meroxa_remove_connector.md +++ b/docs/cmd/meroxa_remove_connector.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa remove connector" -slug: meroxa_remove_connector -url: /cli/meroxa_remove_connector/ ---- ## meroxa remove connector Remove connector @@ -31,5 +24,5 @@ meroxa remove connector NAME [flags] ### SEE ALSO -* [meroxa remove](meroxa_remove) - Remove a component +* [meroxa remove](meroxa_remove.md) - Remove a component diff --git a/docs/cmd/meroxa_remove_endpoint.md b/docs/cmd/meroxa_remove_endpoint.md index 2d9585475..0e7da6acb 100644 --- a/docs/cmd/meroxa_remove_endpoint.md +++ b/docs/cmd/meroxa_remove_endpoint.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa remove endpoint" -slug: meroxa_remove_endpoint -url: /cli/meroxa_remove_endpoint/ ---- ## meroxa remove endpoint Remove endpoint @@ -31,5 +24,5 @@ meroxa remove endpoint NAME [flags] ### SEE ALSO -* [meroxa remove](meroxa_remove) - Remove a component +* [meroxa remove](meroxa_remove.md) - Remove a component diff --git a/docs/cmd/meroxa_remove_pipeline.md b/docs/cmd/meroxa_remove_pipeline.md index 890cbcdc5..709be5280 100644 --- a/docs/cmd/meroxa_remove_pipeline.md +++ b/docs/cmd/meroxa_remove_pipeline.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa remove pipeline" -slug: meroxa_remove_pipeline -url: /cli/meroxa_remove_pipeline/ ---- ## meroxa remove pipeline Remove pipeline @@ -31,5 +24,5 @@ meroxa remove pipeline NAME [flags] ### SEE ALSO -* [meroxa remove](meroxa_remove) - Remove a component +* [meroxa remove](meroxa_remove.md) - Remove a component diff --git a/docs/cmd/meroxa_remove_resource.md b/docs/cmd/meroxa_remove_resource.md index 3331ef51d..04456a77a 100644 --- a/docs/cmd/meroxa_remove_resource.md +++ b/docs/cmd/meroxa_remove_resource.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa remove resource" -slug: meroxa_remove_resource -url: /cli/meroxa_remove_resource/ ---- ## meroxa remove resource Remove resource @@ -31,5 +24,5 @@ meroxa remove resource NAME [flags] ### SEE ALSO -* [meroxa remove](meroxa_remove) - Remove a component +* [meroxa remove](meroxa_remove.md) - Remove a component diff --git a/docs/cmd/meroxa_update.md b/docs/cmd/meroxa_update.md index a32111d66..348bb8b88 100644 --- a/docs/cmd/meroxa_update.md +++ b/docs/cmd/meroxa_update.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa update" -slug: meroxa_update -url: /cli/meroxa_update/ ---- ## meroxa update Update a component @@ -30,8 +23,8 @@ Update a component of the Meroxa platform, including connectors ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI -* [meroxa update connector](meroxa_update_connector) - Update connector state -* [meroxa update pipeline](meroxa_update_pipeline) - Update pipeline state -* [meroxa update resource](meroxa_update_resource) - Update a resource +* [meroxa](meroxa.md) - The Meroxa CLI +* [meroxa update connector](meroxa_update_connector.md) - Update connector state +* [meroxa update pipeline](meroxa_update_pipeline.md) - Update pipeline state +* [meroxa update resource](meroxa_update_resource.md) - Update a resource diff --git a/docs/cmd/meroxa_update_connector.md b/docs/cmd/meroxa_update_connector.md index f0b1101df..2118a2197 100644 --- a/docs/cmd/meroxa_update_connector.md +++ b/docs/cmd/meroxa_update_connector.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa update connector" -slug: meroxa_update_connector -url: /cli/meroxa_update_connector/ ---- ## meroxa update connector Update connector state @@ -31,5 +24,5 @@ meroxa update connector NAME --state pause | resume | restart [flags] ### SEE ALSO -* [meroxa update](meroxa_update) - Update a component +* [meroxa update](meroxa_update.md) - Update a component diff --git a/docs/cmd/meroxa_update_pipeline.md b/docs/cmd/meroxa_update_pipeline.md index 6fecf878c..89e8e8900 100644 --- a/docs/cmd/meroxa_update_pipeline.md +++ b/docs/cmd/meroxa_update_pipeline.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa update pipeline" -slug: meroxa_update_pipeline -url: /cli/meroxa_update_pipeline/ ---- ## meroxa update pipeline Update pipeline state @@ -42,5 +35,5 @@ meroxa update pipeline pipeline-name --metadata '{"key":"value"}' ### SEE ALSO -* [meroxa update](meroxa_update) - Update a component +* [meroxa update](meroxa_update.md) - Update a component diff --git a/docs/cmd/meroxa_update_resource.md b/docs/cmd/meroxa_update_resource.md index f9baaed4b..2f352292b 100644 --- a/docs/cmd/meroxa_update_resource.md +++ b/docs/cmd/meroxa_update_resource.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa update resource" -slug: meroxa_update_resource -url: /cli/meroxa_update_resource/ ---- ## meroxa update resource Update a resource @@ -38,5 +31,5 @@ meroxa update resource NAME [flags] ### SEE ALSO -* [meroxa update](meroxa_update) - Update a component +* [meroxa update](meroxa_update.md) - Update a component diff --git a/docs/cmd/meroxa_version.md b/docs/cmd/meroxa_version.md index c5a442c92..3901bae1e 100644 --- a/docs/cmd/meroxa_version.md +++ b/docs/cmd/meroxa_version.md @@ -1,10 +1,3 @@ ---- -createdAt: 2021-04-14T11:12:19-04:00 -updatedAt: 2021-04-14T11:12:19-04:00 -title: "meroxa version" -slug: meroxa_version -url: /cli/meroxa_version/ ---- ## meroxa version Display the Meroxa CLI version @@ -30,5 +23,5 @@ meroxa version [flags] ### SEE ALSO -* [meroxa](meroxa) - The Meroxa CLI +* [meroxa](meroxa.md) - The Meroxa CLI diff --git a/gen-docs/main.go b/gen-docs/main.go index 3c9102024..6ce2e457c 100644 --- a/gen-docs/main.go +++ b/gen-docs/main.go @@ -23,6 +23,28 @@ url: %s --- ` +func renameFromUnderscoreToDash(dir string) { + file, err := os.Open(dir) + if err != nil { + log.Fatalf("failed opening directory: %s", err) + } + defer file.Close() + + list, err := file.Readdirnames(0) // 0 to read all files and folders + if err != nil { + log.Fatalf("failed reading directory: %s", err) + } + for _, name := range list { + oldName := name + newName := strings.Replace(oldName, "_", "-", -1) + err := os.Rename(filepath.Join(dir, oldName), filepath.Join(dir, newName)) + if err != nil { + log.Printf("error renaming file: %s", err) + continue + } + } +} + func main() { // set HOME env var so that default values involve user's home directory do not depend on the running user. os.Setenv("HOME", "/home/user") @@ -41,25 +63,35 @@ func main() { log.Fatal(err) } + // Generating Markdown Documents + err := doc.GenMarkdownTree(rootCmd, "./docs/cmd") + if err != nil { + log.Fatal(err) + } + filePrepender := func(filename string) string { createdAt := time.Now().Format(time.RFC3339) name := filepath.Base(filename) base := strings.TrimSuffix(name, path.Ext(name)) - url := "/cli/" + strings.ToLower(base) + "/" - return fmt.Sprintf(fmTemplate, createdAt, createdAt, strings.Replace(base, "_", " ", -1), base, url) + slug := strings.Replace(base, "_", "-", -1) + url := "/cli/" + strings.ToLower(slug) + "/" + return fmt.Sprintf(fmTemplate, createdAt, createdAt, strings.Replace(base, "_", " ", -1), slug, url) } linkHandler := func(name string) string { base := strings.TrimSuffix(name, path.Ext(name)) - return strings.ToLower(base) + slug := strings.Replace(base, "_", "-", -1) + return "/cli/" + strings.ToLower(slug) + "/" } // Generating Markdown Documents - err := doc.GenMarkdownTreeCustom(rootCmd, "./docs/cmd", filePrepender, linkHandler) - if err != nil { + errWeb := doc.GenMarkdownTreeCustom(rootCmd, "./docs/web", filePrepender, linkHandler) + if errWeb != nil { log.Fatal(err) } + renameFromUnderscoreToDash("./docs/web") + // Generating Bash Completion File if err := rootCmd.GenBashCompletionFile("./etc/completion/meroxa.completion.sh"); err != nil { log.Fatal(err) From 7094c47be7fb035d5effeb3fb008594d666d888d Mon Sep 17 00:00:00 2001 From: Taron Foxworth Date: Wed, 14 Apr 2021 11:25:31 -0400 Subject: [PATCH 3/4] add docs/web folder --- docs/web/meroxa-add-resource.md | 52 ++++++++++++++++++++ docs/web/meroxa-add.md | 30 ++++++++++++ docs/web/meroxa-api.md | 41 ++++++++++++++++ docs/web/meroxa-billing.md | 33 +++++++++++++ docs/web/meroxa-completion.md | 67 ++++++++++++++++++++++++++ docs/web/meroxa-connect.md | 53 ++++++++++++++++++++ docs/web/meroxa-create-connector.md | 51 ++++++++++++++++++++ docs/web/meroxa-create-endpoint.md | 46 ++++++++++++++++++ docs/web/meroxa-create-pipeline.md | 34 +++++++++++++ docs/web/meroxa-create.md | 37 ++++++++++++++ docs/web/meroxa-describe-connector.md | 33 +++++++++++++ docs/web/meroxa-describe-endpoint.md | 33 +++++++++++++ docs/web/meroxa-describe-resource.md | 33 +++++++++++++ docs/web/meroxa-describe.md | 36 ++++++++++++++ docs/web/meroxa-list-connectors.md | 34 +++++++++++++ docs/web/meroxa-list-endpoint.md | 33 +++++++++++++ docs/web/meroxa-list-pipelines.md | 33 +++++++++++++ docs/web/meroxa-list-resource-types.md | 33 +++++++++++++ docs/web/meroxa-list-resources.md | 33 +++++++++++++ docs/web/meroxa-list-transforms.md | 33 +++++++++++++ docs/web/meroxa-list.md | 40 +++++++++++++++ docs/web/meroxa-login.md | 33 +++++++++++++ docs/web/meroxa-logout.md | 33 +++++++++++++ docs/web/meroxa-logs-connector.md | 33 +++++++++++++ docs/web/meroxa-logs.md | 30 ++++++++++++ docs/web/meroxa-open-billing.md | 33 +++++++++++++ docs/web/meroxa-open.md | 30 ++++++++++++ docs/web/meroxa-remove-connector.md | 34 +++++++++++++ docs/web/meroxa-remove-endpoint.md | 34 +++++++++++++ docs/web/meroxa-remove-pipeline.md | 34 +++++++++++++ docs/web/meroxa-remove-resource.md | 34 +++++++++++++ docs/web/meroxa-remove.md | 39 +++++++++++++++ docs/web/meroxa-update-connector.md | 34 +++++++++++++ docs/web/meroxa-update-pipeline.md | 45 +++++++++++++++++ docs/web/meroxa-update-resource.md | 41 ++++++++++++++++ docs/web/meroxa-update.md | 36 ++++++++++++++ docs/web/meroxa-version.md | 33 +++++++++++++ docs/web/meroxa.md | 48 ++++++++++++++++++ 38 files changed, 1422 insertions(+) create mode 100644 docs/web/meroxa-add-resource.md create mode 100644 docs/web/meroxa-add.md create mode 100644 docs/web/meroxa-api.md create mode 100644 docs/web/meroxa-billing.md create mode 100644 docs/web/meroxa-completion.md create mode 100644 docs/web/meroxa-connect.md create mode 100644 docs/web/meroxa-create-connector.md create mode 100644 docs/web/meroxa-create-endpoint.md create mode 100644 docs/web/meroxa-create-pipeline.md create mode 100644 docs/web/meroxa-create.md create mode 100644 docs/web/meroxa-describe-connector.md create mode 100644 docs/web/meroxa-describe-endpoint.md create mode 100644 docs/web/meroxa-describe-resource.md create mode 100644 docs/web/meroxa-describe.md create mode 100644 docs/web/meroxa-list-connectors.md create mode 100644 docs/web/meroxa-list-endpoint.md create mode 100644 docs/web/meroxa-list-pipelines.md create mode 100644 docs/web/meroxa-list-resource-types.md create mode 100644 docs/web/meroxa-list-resources.md create mode 100644 docs/web/meroxa-list-transforms.md create mode 100644 docs/web/meroxa-list.md create mode 100644 docs/web/meroxa-login.md create mode 100644 docs/web/meroxa-logout.md create mode 100644 docs/web/meroxa-logs-connector.md create mode 100644 docs/web/meroxa-logs.md create mode 100644 docs/web/meroxa-open-billing.md create mode 100644 docs/web/meroxa-open.md create mode 100644 docs/web/meroxa-remove-connector.md create mode 100644 docs/web/meroxa-remove-endpoint.md create mode 100644 docs/web/meroxa-remove-pipeline.md create mode 100644 docs/web/meroxa-remove-resource.md create mode 100644 docs/web/meroxa-remove.md create mode 100644 docs/web/meroxa-update-connector.md create mode 100644 docs/web/meroxa-update-pipeline.md create mode 100644 docs/web/meroxa-update-resource.md create mode 100644 docs/web/meroxa-update.md create mode 100644 docs/web/meroxa-version.md create mode 100644 docs/web/meroxa.md diff --git a/docs/web/meroxa-add-resource.md b/docs/web/meroxa-add-resource.md new file mode 100644 index 000000000..222da1a1c --- /dev/null +++ b/docs/web/meroxa-add-resource.md @@ -0,0 +1,52 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa add resource" +slug: meroxa-add-resource +url: /cli/meroxa-add-resource/ +--- +## meroxa add resource + +Add a resource to your Meroxa resource catalog + +### Synopsis + +Use the add command to add resources to your Meroxa resource catalog. + +``` +meroxa add resource [NAME] --type TYPE [flags] +``` + +### Examples + +``` + +meroxa add resource store --type postgres -u $DATABASE_URL --metadata '{"logical_replication":true}' +meroxa add resource datalake --type s3 -u "s3://$AWS_ACCESS_KEY_ID:$AWS_ACCESS_KEY_SECRET@us-east-1/meroxa-demos" +meroxa add resource warehouse --type redshift -u $REDSHIFT_URL +meroxa add resource slack --type url -u $WEBHOOK_URL + +``` + +### Options + +``` + --credentials string resource credentials + -h, --help help for resource + -m, --metadata string resource metadata + --type string resource type + -u, --url string resource url +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa add](/cli/meroxa-add/) - Add a resource to your Meroxa resource catalog + diff --git a/docs/web/meroxa-add.md b/docs/web/meroxa-add.md new file mode 100644 index 000000000..07939405d --- /dev/null +++ b/docs/web/meroxa-add.md @@ -0,0 +1,30 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa add" +slug: meroxa-add +url: /cli/meroxa-add/ +--- +## meroxa add + +Add a resource to your Meroxa resource catalog + +### Options + +``` + -h, --help help for add +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI +* [meroxa add resource](/cli/meroxa-add-resource/) - Add a resource to your Meroxa resource catalog + diff --git a/docs/web/meroxa-api.md b/docs/web/meroxa-api.md new file mode 100644 index 000000000..dca001e0b --- /dev/null +++ b/docs/web/meroxa-api.md @@ -0,0 +1,41 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa api" +slug: meroxa-api +url: /cli/meroxa-api/ +--- +## meroxa api + +Invoke Meroxa API + +``` +meroxa api METHOD PATH [body] [flags] +``` + +### Examples + +``` + +meroxa api GET /v1/endpoints +meroxa api POST /v1/endpoints '{"protocol": "HTTP", "stream": "resource-2-499379-public.accounts", "name": "1234"}' +``` + +### Options + +``` + -h, --help help for api +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI + diff --git a/docs/web/meroxa-billing.md b/docs/web/meroxa-billing.md new file mode 100644 index 000000000..41424ed8c --- /dev/null +++ b/docs/web/meroxa-billing.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa billing" +slug: meroxa-billing +url: /cli/meroxa-billing/ +--- +## meroxa billing + +Open your billing page in a web browser + +``` +meroxa billing [flags] +``` + +### Options + +``` + -h, --help help for billing +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI + diff --git a/docs/web/meroxa-completion.md b/docs/web/meroxa-completion.md new file mode 100644 index 000000000..c5369aadd --- /dev/null +++ b/docs/web/meroxa-completion.md @@ -0,0 +1,67 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa completion" +slug: meroxa-completion +url: /cli/meroxa-completion/ +--- +## meroxa completion + +Generate completion script + +### Synopsis + +To load completions: + + Bash: + + $ source <(meroxa completion bash) + + # To load completions for each session, execute once: + Linux: + $ meroxa completion bash > /etc/bash_completion.d/meroxa + MacOS: + $ meroxa completion bash > /usr/local/etc/bash_completion.d/meroxa + + Zsh: + + # If shell completion is not already enabled in your environment you will need + # to enable it. You can execute the following once: + + $ echo "autoload -U compinit; compinit" >> ~/.zshrc + + # To load completions for each session, execute once: + $ meroxa completion zsh > "${fpath[1]}/_meroxa" + + # You will need to start a new shell for this setup to take effect. + + Fish: + + $ meroxa completion fish | source + + # To load completions for each session, execute once: + $ meroxa completion fish > ~/.config/fish/completions/meroxa.fish + + +``` +meroxa completion [bash|zsh|fish|powershell] +``` + +### Options + +``` + -h, --help help for completion +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI + diff --git a/docs/web/meroxa-connect.md b/docs/web/meroxa-connect.md new file mode 100644 index 000000000..3d9093f0b --- /dev/null +++ b/docs/web/meroxa-connect.md @@ -0,0 +1,53 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa connect" +slug: meroxa-connect +url: /cli/meroxa-connect/ +--- +## meroxa connect + +Connect two resources together + +### Synopsis + +Use the connect command to automatically configure the connectors required to pull data from one resource +(source) to another (destination). + +This command is equivalent to creating two connectors separately, one from the source to Meroxa and another from Meroxa +to the destination: + +meroxa connect --from RESOURCE-NAME --to RESOURCE-NAME --input SOURCE-INPUT + +or + +meroxa create connector --from postgres --input accounts # Creates source connector +meroxa create connector --to redshift --input orders # Creates destination connector + + +``` +meroxa connect --from RESOURCE-NAME --to RESOURCE-NAME [flags] +``` + +### Options + +``` + --from string source resource name + -h, --help help for connect + --input string command delimeted list of input streams + --pipeline string pipeline name to attach connectors to + --to string destination resource name +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI + diff --git a/docs/web/meroxa-create-connector.md b/docs/web/meroxa-create-connector.md new file mode 100644 index 000000000..de17360da --- /dev/null +++ b/docs/web/meroxa-create-connector.md @@ -0,0 +1,51 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa create connector" +slug: meroxa-create-connector +url: /cli/meroxa-create-connector/ +--- +## meroxa create connector + +Create a connector + +### Synopsis + +Use create connector to create a connector from a source (--from) or to a destination (--to) + +``` +meroxa create connector [NAME] [flags] +``` + +### Examples + +``` + +meroxa create connector [NAME] --from pg2kafka --input accounts +meroxa create connector [NAME] --to pg2redshift --input orders # --input will be the desired stream +meroxa create connector [NAME] --to pg2redshift --input orders --pipeline my-pipeline + +``` + +### Options + +``` + --from string resource name to use as source + -h, --help help for connector + --input string command delimited list of input streams + --pipeline string pipeline name to attach connector to + --to string resource name to use as destination +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa create](/cli/meroxa-create/) - Create Meroxa pipeline components + diff --git a/docs/web/meroxa-create-endpoint.md b/docs/web/meroxa-create-endpoint.md new file mode 100644 index 000000000..b7cfbf1ef --- /dev/null +++ b/docs/web/meroxa-create-endpoint.md @@ -0,0 +1,46 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa create endpoint" +slug: meroxa-create-endpoint +url: /cli/meroxa-create-endpoint/ +--- +## meroxa create endpoint + +Create an endpoint + +### Synopsis + +Use create endpoint to expose an endpoint to a connector stream + +``` +meroxa create endpoint [NAME] [flags] +``` + +### Examples + +``` + +meroxa create endpoint my-endpoint --protocol http --stream my-stream +``` + +### Options + +``` + -h, --help help for endpoint + -p, --protocol string protocol, value can be http or grpc (required) + -s, --stream string stream name (required) +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa create](/cli/meroxa-create/) - Create Meroxa pipeline components + diff --git a/docs/web/meroxa-create-pipeline.md b/docs/web/meroxa-create-pipeline.md new file mode 100644 index 000000000..10c344c76 --- /dev/null +++ b/docs/web/meroxa-create-pipeline.md @@ -0,0 +1,34 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa create pipeline" +slug: meroxa-create-pipeline +url: /cli/meroxa-create-pipeline/ +--- +## meroxa create pipeline + +Create a pipeline + +``` +meroxa create pipeline NAME [flags] +``` + +### Options + +``` + -h, --help help for pipeline + -m, --metadata string pipeline metadata +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa create](/cli/meroxa-create/) - Create Meroxa pipeline components + diff --git a/docs/web/meroxa-create.md b/docs/web/meroxa-create.md new file mode 100644 index 000000000..9e79be82e --- /dev/null +++ b/docs/web/meroxa-create.md @@ -0,0 +1,37 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa create" +slug: meroxa-create +url: /cli/meroxa-create/ +--- +## meroxa create + +Create Meroxa pipeline components + +### Synopsis + +Use the create command to create various Meroxa pipeline components +including connectors. + +### Options + +``` + -h, --help help for create +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI +* [meroxa create connector](/cli/meroxa-create-connector/) - Create a connector +* [meroxa create endpoint](/cli/meroxa-create-endpoint/) - Create an endpoint +* [meroxa create pipeline](/cli/meroxa-create-pipeline/) - Create a pipeline + diff --git a/docs/web/meroxa-describe-connector.md b/docs/web/meroxa-describe-connector.md new file mode 100644 index 000000000..1c89e709d --- /dev/null +++ b/docs/web/meroxa-describe-connector.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa describe connector" +slug: meroxa-describe-connector +url: /cli/meroxa-describe-connector/ +--- +## meroxa describe connector + +Describe connector + +``` +meroxa describe connector [name] [flags] +``` + +### Options + +``` + -h, --help help for connector +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa describe](/cli/meroxa-describe/) - Describe a component + diff --git a/docs/web/meroxa-describe-endpoint.md b/docs/web/meroxa-describe-endpoint.md new file mode 100644 index 000000000..9d1430011 --- /dev/null +++ b/docs/web/meroxa-describe-endpoint.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa describe endpoint" +slug: meroxa-describe-endpoint +url: /cli/meroxa-describe-endpoint/ +--- +## meroxa describe endpoint + +Describe endpoint + +``` +meroxa describe endpoint NAME [flags] +``` + +### Options + +``` + -h, --help help for endpoint +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa describe](/cli/meroxa-describe/) - Describe a component + diff --git a/docs/web/meroxa-describe-resource.md b/docs/web/meroxa-describe-resource.md new file mode 100644 index 000000000..1e62e18fe --- /dev/null +++ b/docs/web/meroxa-describe-resource.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa describe resource" +slug: meroxa-describe-resource +url: /cli/meroxa-describe-resource/ +--- +## meroxa describe resource + +Describe resource + +``` +meroxa describe resource NAME [flags] +``` + +### Options + +``` + -h, --help help for resource +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa describe](/cli/meroxa-describe/) - Describe a component + diff --git a/docs/web/meroxa-describe.md b/docs/web/meroxa-describe.md new file mode 100644 index 000000000..1348f2126 --- /dev/null +++ b/docs/web/meroxa-describe.md @@ -0,0 +1,36 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa describe" +slug: meroxa-describe +url: /cli/meroxa-describe/ +--- +## meroxa describe + +Describe a component + +### Synopsis + +Describe a component of the Meroxa data platform, including resources and connectors + +### Options + +``` + -h, --help help for describe +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI +* [meroxa describe connector](/cli/meroxa-describe-connector/) - Describe connector +* [meroxa describe endpoint](/cli/meroxa-describe-endpoint/) - Describe endpoint +* [meroxa describe resource](/cli/meroxa-describe-resource/) - Describe resource + diff --git a/docs/web/meroxa-list-connectors.md b/docs/web/meroxa-list-connectors.md new file mode 100644 index 000000000..52afed9cd --- /dev/null +++ b/docs/web/meroxa-list-connectors.md @@ -0,0 +1,34 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa list connectors" +slug: meroxa-list-connectors +url: /cli/meroxa-list-connectors/ +--- +## meroxa list connectors + +List connectors + +``` +meroxa list connectors [flags] +``` + +### Options + +``` + -h, --help help for connectors + --pipeline string filter connectors by pipeline name +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa list](/cli/meroxa-list/) - List components + diff --git a/docs/web/meroxa-list-endpoint.md b/docs/web/meroxa-list-endpoint.md new file mode 100644 index 000000000..15b389361 --- /dev/null +++ b/docs/web/meroxa-list-endpoint.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa list endpoint" +slug: meroxa-list-endpoint +url: /cli/meroxa-list-endpoint/ +--- +## meroxa list endpoint + +List endpoints + +``` +meroxa list endpoint [flags] +``` + +### Options + +``` + -h, --help help for endpoint +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa list](/cli/meroxa-list/) - List components + diff --git a/docs/web/meroxa-list-pipelines.md b/docs/web/meroxa-list-pipelines.md new file mode 100644 index 000000000..a9693008f --- /dev/null +++ b/docs/web/meroxa-list-pipelines.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa list pipelines" +slug: meroxa-list-pipelines +url: /cli/meroxa-list-pipelines/ +--- +## meroxa list pipelines + +List pipelines + +``` +meroxa list pipelines [flags] +``` + +### Options + +``` + -h, --help help for pipelines +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa list](/cli/meroxa-list/) - List components + diff --git a/docs/web/meroxa-list-resource-types.md b/docs/web/meroxa-list-resource-types.md new file mode 100644 index 000000000..b42788c5b --- /dev/null +++ b/docs/web/meroxa-list-resource-types.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa list resource-types" +slug: meroxa-list-resource-types +url: /cli/meroxa-list-resource-types/ +--- +## meroxa list resource-types + +List resource-types + +``` +meroxa list resource-types [flags] +``` + +### Options + +``` + -h, --help help for resource-types +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa list](/cli/meroxa-list/) - List components + diff --git a/docs/web/meroxa-list-resources.md b/docs/web/meroxa-list-resources.md new file mode 100644 index 000000000..ffb04fd16 --- /dev/null +++ b/docs/web/meroxa-list-resources.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa list resources" +slug: meroxa-list-resources +url: /cli/meroxa-list-resources/ +--- +## meroxa list resources + +List resources + +``` +meroxa list resources [flags] +``` + +### Options + +``` + -h, --help help for resources +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa list](/cli/meroxa-list/) - List components + diff --git a/docs/web/meroxa-list-transforms.md b/docs/web/meroxa-list-transforms.md new file mode 100644 index 000000000..d70cc4dba --- /dev/null +++ b/docs/web/meroxa-list-transforms.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa list transforms" +slug: meroxa-list-transforms +url: /cli/meroxa-list-transforms/ +--- +## meroxa list transforms + +List transforms + +``` +meroxa list transforms [flags] +``` + +### Options + +``` + -h, --help help for transforms +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa list](/cli/meroxa-list/) - List components + diff --git a/docs/web/meroxa-list.md b/docs/web/meroxa-list.md new file mode 100644 index 000000000..599b62e7f --- /dev/null +++ b/docs/web/meroxa-list.md @@ -0,0 +1,40 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa list" +slug: meroxa-list +url: /cli/meroxa-list/ +--- +## meroxa list + +List components + +### Synopsis + +List the components of the Meroxa platform, including pipelines, + resources, connectors, etc... You may also filter by type. + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI +* [meroxa list connectors](/cli/meroxa-list-connectors/) - List connectors +* [meroxa list endpoint](/cli/meroxa-list-endpoint/) - List endpoints +* [meroxa list pipelines](/cli/meroxa-list-pipelines/) - List pipelines +* [meroxa list resource-types](/cli/meroxa-list-resource-types/) - List resource-types +* [meroxa list resources](/cli/meroxa-list-resources/) - List resources +* [meroxa list transforms](/cli/meroxa-list-transforms/) - List transforms + diff --git a/docs/web/meroxa-login.md b/docs/web/meroxa-login.md new file mode 100644 index 000000000..6b053eff6 --- /dev/null +++ b/docs/web/meroxa-login.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa login" +slug: meroxa-login +url: /cli/meroxa-login/ +--- +## meroxa login + +login or sign up to the Meroxa platform + +``` +meroxa login [flags] +``` + +### Options + +``` + -h, --help help for login +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI + diff --git a/docs/web/meroxa-logout.md b/docs/web/meroxa-logout.md new file mode 100644 index 000000000..6529ef267 --- /dev/null +++ b/docs/web/meroxa-logout.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa logout" +slug: meroxa-logout +url: /cli/meroxa-logout/ +--- +## meroxa logout + +logout of the Meroxa platform + +``` +meroxa logout [flags] +``` + +### Options + +``` + -h, --help help for logout +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI + diff --git a/docs/web/meroxa-logs-connector.md b/docs/web/meroxa-logs-connector.md new file mode 100644 index 000000000..61e99eb84 --- /dev/null +++ b/docs/web/meroxa-logs-connector.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa logs connector" +slug: meroxa-logs-connector +url: /cli/meroxa-logs-connector/ +--- +## meroxa logs connector + +Print logs for a connector + +``` +meroxa logs connector NAME [flags] +``` + +### Options + +``` + -h, --help help for connector +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa logs](/cli/meroxa-logs/) - Print logs for a component + diff --git a/docs/web/meroxa-logs.md b/docs/web/meroxa-logs.md new file mode 100644 index 000000000..89f0cb0e8 --- /dev/null +++ b/docs/web/meroxa-logs.md @@ -0,0 +1,30 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa logs" +slug: meroxa-logs +url: /cli/meroxa-logs/ +--- +## meroxa logs + +Print logs for a component + +### Options + +``` + -h, --help help for logs +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI +* [meroxa logs connector](/cli/meroxa-logs-connector/) - Print logs for a connector + diff --git a/docs/web/meroxa-open-billing.md b/docs/web/meroxa-open-billing.md new file mode 100644 index 000000000..2448dba63 --- /dev/null +++ b/docs/web/meroxa-open-billing.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa open billing" +slug: meroxa-open-billing +url: /cli/meroxa-open-billing/ +--- +## meroxa open billing + +Open your billing page in a web browser + +``` +meroxa open billing [flags] +``` + +### Options + +``` + -h, --help help for billing +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa open](/cli/meroxa-open/) - Open in a web browser + diff --git a/docs/web/meroxa-open.md b/docs/web/meroxa-open.md new file mode 100644 index 000000000..1912c70f5 --- /dev/null +++ b/docs/web/meroxa-open.md @@ -0,0 +1,30 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa open" +slug: meroxa-open +url: /cli/meroxa-open/ +--- +## meroxa open + +Open in a web browser + +### Options + +``` + -h, --help help for open +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI +* [meroxa open billing](/cli/meroxa-open-billing/) - Open your billing page in a web browser + diff --git a/docs/web/meroxa-remove-connector.md b/docs/web/meroxa-remove-connector.md new file mode 100644 index 000000000..a179c538c --- /dev/null +++ b/docs/web/meroxa-remove-connector.md @@ -0,0 +1,34 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa remove connector" +slug: meroxa-remove-connector +url: /cli/meroxa-remove-connector/ +--- +## meroxa remove connector + +Remove connector + +``` +meroxa remove connector NAME [flags] +``` + +### Options + +``` + -h, --help help for connector +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -f, --force force delete without confirmation prompt + --json output json +``` + +### SEE ALSO + +* [meroxa remove](/cli/meroxa-remove/) - Remove a component + diff --git a/docs/web/meroxa-remove-endpoint.md b/docs/web/meroxa-remove-endpoint.md new file mode 100644 index 000000000..914632901 --- /dev/null +++ b/docs/web/meroxa-remove-endpoint.md @@ -0,0 +1,34 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa remove endpoint" +slug: meroxa-remove-endpoint +url: /cli/meroxa-remove-endpoint/ +--- +## meroxa remove endpoint + +Remove endpoint + +``` +meroxa remove endpoint NAME [flags] +``` + +### Options + +``` + -h, --help help for endpoint +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -f, --force force delete without confirmation prompt + --json output json +``` + +### SEE ALSO + +* [meroxa remove](/cli/meroxa-remove/) - Remove a component + diff --git a/docs/web/meroxa-remove-pipeline.md b/docs/web/meroxa-remove-pipeline.md new file mode 100644 index 000000000..25e146d7d --- /dev/null +++ b/docs/web/meroxa-remove-pipeline.md @@ -0,0 +1,34 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa remove pipeline" +slug: meroxa-remove-pipeline +url: /cli/meroxa-remove-pipeline/ +--- +## meroxa remove pipeline + +Remove pipeline + +``` +meroxa remove pipeline NAME [flags] +``` + +### Options + +``` + -h, --help help for pipeline +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -f, --force force delete without confirmation prompt + --json output json +``` + +### SEE ALSO + +* [meroxa remove](/cli/meroxa-remove/) - Remove a component + diff --git a/docs/web/meroxa-remove-resource.md b/docs/web/meroxa-remove-resource.md new file mode 100644 index 000000000..ee8226f95 --- /dev/null +++ b/docs/web/meroxa-remove-resource.md @@ -0,0 +1,34 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa remove resource" +slug: meroxa-remove-resource +url: /cli/meroxa-remove-resource/ +--- +## meroxa remove resource + +Remove resource + +``` +meroxa remove resource NAME [flags] +``` + +### Options + +``` + -h, --help help for resource +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -f, --force force delete without confirmation prompt + --json output json +``` + +### SEE ALSO + +* [meroxa remove](/cli/meroxa-remove/) - Remove a component + diff --git a/docs/web/meroxa-remove.md b/docs/web/meroxa-remove.md new file mode 100644 index 000000000..cfb23e5df --- /dev/null +++ b/docs/web/meroxa-remove.md @@ -0,0 +1,39 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa remove" +slug: meroxa-remove +url: /cli/meroxa-remove/ +--- +## meroxa remove + +Remove a component + +### Synopsis + +Deprovision a component of the Meroxa platform, including pipelines, + resources, and connectors + +### Options + +``` + -f, --force force delete without confirmation prompt + -h, --help help for remove +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI +* [meroxa remove connector](/cli/meroxa-remove-connector/) - Remove connector +* [meroxa remove endpoint](/cli/meroxa-remove-endpoint/) - Remove endpoint +* [meroxa remove pipeline](/cli/meroxa-remove-pipeline/) - Remove pipeline +* [meroxa remove resource](/cli/meroxa-remove-resource/) - Remove resource + diff --git a/docs/web/meroxa-update-connector.md b/docs/web/meroxa-update-connector.md new file mode 100644 index 000000000..9654b36a0 --- /dev/null +++ b/docs/web/meroxa-update-connector.md @@ -0,0 +1,34 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa update connector" +slug: meroxa-update-connector +url: /cli/meroxa-update-connector/ +--- +## meroxa update connector + +Update connector state + +``` +meroxa update connector NAME --state pause | resume | restart [flags] +``` + +### Options + +``` + -h, --help help for connector + --state string connector state +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa update](/cli/meroxa-update/) - Update a component + diff --git a/docs/web/meroxa-update-pipeline.md b/docs/web/meroxa-update-pipeline.md new file mode 100644 index 000000000..57f5a9049 --- /dev/null +++ b/docs/web/meroxa-update-pipeline.md @@ -0,0 +1,45 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa update pipeline" +slug: meroxa-update-pipeline +url: /cli/meroxa-update-pipeline/ +--- +## meroxa update pipeline + +Update pipeline state + +``` +meroxa update pipeline NAME [flags] +``` + +### Examples + +``` + +meroxa update pipeline old-name --name new-name +meroxa update pipeline pipeline-name --state pause +meroxa update pipeline pipeline-name --metadata '{"key":"value"}' +``` + +### Options + +``` + -h, --help help for pipeline + -m, --metadata string new pipeline metadata + --name string new pipeline name + --state string new pipeline state +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa update](/cli/meroxa-update/) - Update a component + diff --git a/docs/web/meroxa-update-resource.md b/docs/web/meroxa-update-resource.md new file mode 100644 index 000000000..424f9b508 --- /dev/null +++ b/docs/web/meroxa-update-resource.md @@ -0,0 +1,41 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa update resource" +slug: meroxa-update-resource +url: /cli/meroxa-update-resource/ +--- +## meroxa update resource + +Update a resource + +### Synopsis + +Use the update command to update various Meroxa resources. + +``` +meroxa update resource NAME [flags] +``` + +### Options + +``` + --credentials string new resource credentials + -h, --help help for resource + -m, --metadata string new resource metadata + --name string new resource name + -u, --url string new resource url +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa update](/cli/meroxa-update/) - Update a component + diff --git a/docs/web/meroxa-update.md b/docs/web/meroxa-update.md new file mode 100644 index 000000000..a75223ac1 --- /dev/null +++ b/docs/web/meroxa-update.md @@ -0,0 +1,36 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa update" +slug: meroxa-update +url: /cli/meroxa-update/ +--- +## meroxa update + +Update a component + +### Synopsis + +Update a component of the Meroxa platform, including connectors + +### Options + +``` + -h, --help help for update +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI +* [meroxa update connector](/cli/meroxa-update-connector/) - Update connector state +* [meroxa update pipeline](/cli/meroxa-update-pipeline/) - Update pipeline state +* [meroxa update resource](/cli/meroxa-update-resource/) - Update a resource + diff --git a/docs/web/meroxa-version.md b/docs/web/meroxa-version.md new file mode 100644 index 000000000..126e853e2 --- /dev/null +++ b/docs/web/meroxa-version.md @@ -0,0 +1,33 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa version" +slug: meroxa-version +url: /cli/meroxa-version/ +--- +## meroxa version + +Display the Meroxa CLI version + +``` +meroxa version [flags] +``` + +### Options + +``` + -h, --help help for version +``` + +### Options inherited from parent commands + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json +``` + +### SEE ALSO + +* [meroxa](/cli/meroxa/) - The Meroxa CLI + diff --git a/docs/web/meroxa.md b/docs/web/meroxa.md new file mode 100644 index 000000000..233fa4b09 --- /dev/null +++ b/docs/web/meroxa.md @@ -0,0 +1,48 @@ +--- +createdAt: 2021-04-14T11:24:43-04:00 +updatedAt: 2021-04-14T11:24:43-04:00 +title: "meroxa" +slug: meroxa +url: /cli/meroxa/ +--- +## meroxa + +The Meroxa CLI + +### Synopsis + +The Meroxa CLI allows quick and easy access to the Meroxa data platform. + +Using the CLI you are able to create and manage sophisticated data pipelines +with only a few simple commands. You can get started by listing the supported +resource types: + +meroxa list resource-types + +### Options + +``` + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -h, --help help for meroxa + --json output json +``` + +### SEE ALSO + +* [meroxa add](/cli/meroxa-add/) - Add a resource to your Meroxa resource catalog +* [meroxa api](/cli/meroxa-api/) - Invoke Meroxa API +* [meroxa billing](/cli/meroxa-billing/) - Open your billing page in a web browser +* [meroxa completion](/cli/meroxa-completion/) - Generate completion script +* [meroxa connect](/cli/meroxa-connect/) - Connect two resources together +* [meroxa create](/cli/meroxa-create/) - Create Meroxa pipeline components +* [meroxa describe](/cli/meroxa-describe/) - Describe a component +* [meroxa list](/cli/meroxa-list/) - List components +* [meroxa login](/cli/meroxa-login/) - login or sign up to the Meroxa platform +* [meroxa logout](/cli/meroxa-logout/) - logout of the Meroxa platform +* [meroxa logs](/cli/meroxa-logs/) - Print logs for a component +* [meroxa open](/cli/meroxa-open/) - Open in a web browser +* [meroxa remove](/cli/meroxa-remove/) - Remove a component +* [meroxa update](/cli/meroxa-update/) - Update a component +* [meroxa version](/cli/meroxa-version/) - Display the Meroxa CLI version + From 8e617cf181b72175b00d95a3aeb8f597708df33a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Barroso?= Date: Thu, 15 Apr 2021 10:25:04 +0200 Subject: [PATCH 4/4] refactor: Generation docs --- Makefile | 2 +- README.md | 2 +- docs/cmd/{ => md}/meroxa.md | 0 docs/cmd/{ => md}/meroxa_add.md | 0 docs/cmd/{ => md}/meroxa_add_resource.md | 0 docs/cmd/{ => md}/meroxa_api.md | 0 docs/cmd/{ => md}/meroxa_billing.md | 0 docs/cmd/{ => md}/meroxa_completion.md | 0 docs/cmd/{ => md}/meroxa_connect.md | 0 docs/cmd/{ => md}/meroxa_create.md | 0 docs/cmd/{ => md}/meroxa_create_connector.md | 0 docs/cmd/{ => md}/meroxa_create_endpoint.md | 0 docs/cmd/{ => md}/meroxa_create_pipeline.md | 0 docs/cmd/{ => md}/meroxa_describe.md | 0 .../cmd/{ => md}/meroxa_describe_connector.md | 0 docs/cmd/{ => md}/meroxa_describe_endpoint.md | 0 docs/cmd/{ => md}/meroxa_describe_resource.md | 0 docs/cmd/{ => md}/meroxa_list.md | 0 docs/cmd/{ => md}/meroxa_list_connectors.md | 0 docs/cmd/{ => md}/meroxa_list_endpoint.md | 0 docs/cmd/{ => md}/meroxa_list_pipelines.md | 0 .../{ => md}/meroxa_list_resource-types.md | 0 docs/cmd/{ => md}/meroxa_list_resources.md | 0 docs/cmd/{ => md}/meroxa_list_transforms.md | 0 docs/cmd/{ => md}/meroxa_login.md | 0 docs/cmd/{ => md}/meroxa_logout.md | 0 docs/cmd/{ => md}/meroxa_logs.md | 0 docs/cmd/{ => md}/meroxa_logs_connector.md | 0 docs/cmd/{ => md}/meroxa_open.md | 0 docs/cmd/{ => md}/meroxa_open_billing.md | 0 docs/cmd/{ => md}/meroxa_remove.md | 0 docs/cmd/{ => md}/meroxa_remove_connector.md | 0 docs/cmd/{ => md}/meroxa_remove_endpoint.md | 0 docs/cmd/{ => md}/meroxa_remove_pipeline.md | 0 docs/cmd/{ => md}/meroxa_remove_resource.md | 0 docs/cmd/{ => md}/meroxa_update.md | 0 docs/cmd/{ => md}/meroxa_update_connector.md | 0 docs/cmd/{ => md}/meroxa_update_pipeline.md | 0 docs/cmd/{ => md}/meroxa_update_resource.md | 0 docs/cmd/{ => md}/meroxa_version.md | 0 docs/{web => cmd/www}/meroxa-add-resource.md | 11 ++-- docs/{web => cmd/www}/meroxa-add.md | 11 ++-- docs/{web => cmd/www}/meroxa-api.md | 11 ++-- docs/{web => cmd/www}/meroxa-billing.md | 11 ++-- docs/{web => cmd/www}/meroxa-completion.md | 11 ++-- docs/{web => cmd/www}/meroxa-connect.md | 11 ++-- .../www}/meroxa-create-connector.md | 11 ++-- .../www}/meroxa-create-endpoint.md | 11 ++-- .../www}/meroxa-create-pipeline.md | 11 ++-- docs/{web => cmd/www}/meroxa-create.md | 11 ++-- .../www}/meroxa-describe-connector.md | 11 ++-- .../www}/meroxa-describe-endpoint.md | 11 ++-- .../www}/meroxa-describe-resource.md | 11 ++-- docs/{web => cmd/www}/meroxa-describe.md | 11 ++-- .../www}/meroxa-list-connectors.md | 11 ++-- docs/{web => cmd/www}/meroxa-list-endpoint.md | 11 ++-- .../{web => cmd/www}/meroxa-list-pipelines.md | 11 ++-- .../www}/meroxa-list-resource-types.md | 11 ++-- .../{web => cmd/www}/meroxa-list-resources.md | 11 ++-- .../www}/meroxa-list-transforms.md | 11 ++-- docs/{web => cmd/www}/meroxa-list.md | 11 ++-- docs/{web => cmd/www}/meroxa-login.md | 11 ++-- docs/{web => cmd/www}/meroxa-logout.md | 11 ++-- .../{web => cmd/www}/meroxa-logs-connector.md | 11 ++-- docs/{web => cmd/www}/meroxa-logs.md | 11 ++-- docs/{web => cmd/www}/meroxa-open-billing.md | 11 ++-- docs/{web => cmd/www}/meroxa-open.md | 11 ++-- .../www}/meroxa-remove-connector.md | 13 ++-- .../www}/meroxa-remove-endpoint.md | 13 ++-- .../www}/meroxa-remove-pipeline.md | 13 ++-- .../www}/meroxa-remove-resource.md | 13 ++-- docs/{web => cmd/www}/meroxa-remove.md | 11 ++-- .../www}/meroxa-update-connector.md | 11 ++-- .../www}/meroxa-update-pipeline.md | 11 ++-- .../www}/meroxa-update-resource.md | 11 ++-- docs/{web => cmd/www}/meroxa-update.md | 11 ++-- docs/{web => cmd/www}/meroxa-version.md | 11 ++-- docs/{web => cmd/www}/meroxa.md | 13 ++-- gen-docs/main.go | 59 +++++++++++-------- vendor/github.com/meroxa/meroxa-go/debug.go | 11 +++- vendor/modules.txt | 2 +- 81 files changed, 281 insertions(+), 223 deletions(-) rename docs/cmd/{ => md}/meroxa.md (100%) rename docs/cmd/{ => md}/meroxa_add.md (100%) rename docs/cmd/{ => md}/meroxa_add_resource.md (100%) rename docs/cmd/{ => md}/meroxa_api.md (100%) rename docs/cmd/{ => md}/meroxa_billing.md (100%) rename docs/cmd/{ => md}/meroxa_completion.md (100%) rename docs/cmd/{ => md}/meroxa_connect.md (100%) rename docs/cmd/{ => md}/meroxa_create.md (100%) rename docs/cmd/{ => md}/meroxa_create_connector.md (100%) rename docs/cmd/{ => md}/meroxa_create_endpoint.md (100%) rename docs/cmd/{ => md}/meroxa_create_pipeline.md (100%) rename docs/cmd/{ => md}/meroxa_describe.md (100%) rename docs/cmd/{ => md}/meroxa_describe_connector.md (100%) rename docs/cmd/{ => md}/meroxa_describe_endpoint.md (100%) rename docs/cmd/{ => md}/meroxa_describe_resource.md (100%) rename docs/cmd/{ => md}/meroxa_list.md (100%) rename docs/cmd/{ => md}/meroxa_list_connectors.md (100%) rename docs/cmd/{ => md}/meroxa_list_endpoint.md (100%) rename docs/cmd/{ => md}/meroxa_list_pipelines.md (100%) rename docs/cmd/{ => md}/meroxa_list_resource-types.md (100%) rename docs/cmd/{ => md}/meroxa_list_resources.md (100%) rename docs/cmd/{ => md}/meroxa_list_transforms.md (100%) rename docs/cmd/{ => md}/meroxa_login.md (100%) rename docs/cmd/{ => md}/meroxa_logout.md (100%) rename docs/cmd/{ => md}/meroxa_logs.md (100%) rename docs/cmd/{ => md}/meroxa_logs_connector.md (100%) rename docs/cmd/{ => md}/meroxa_open.md (100%) rename docs/cmd/{ => md}/meroxa_open_billing.md (100%) rename docs/cmd/{ => md}/meroxa_remove.md (100%) rename docs/cmd/{ => md}/meroxa_remove_connector.md (100%) rename docs/cmd/{ => md}/meroxa_remove_endpoint.md (100%) rename docs/cmd/{ => md}/meroxa_remove_pipeline.md (100%) rename docs/cmd/{ => md}/meroxa_remove_resource.md (100%) rename docs/cmd/{ => md}/meroxa_update.md (100%) rename docs/cmd/{ => md}/meroxa_update_connector.md (100%) rename docs/cmd/{ => md}/meroxa_update_pipeline.md (100%) rename docs/cmd/{ => md}/meroxa_update_resource.md (100%) rename docs/cmd/{ => md}/meroxa_version.md (100%) rename docs/{web => cmd/www}/meroxa-add-resource.md (77%) rename docs/{web => cmd/www}/meroxa-add.md (56%) rename docs/{web => cmd/www}/meroxa-api.md (60%) rename docs/{web => cmd/www}/meroxa-billing.md (52%) rename docs/{web => cmd/www}/meroxa-completion.md (79%) rename docs/{web => cmd/www}/meroxa-connect.md (79%) rename docs/{web => cmd/www}/meroxa-create-connector.md (77%) rename docs/{web => cmd/www}/meroxa-create-endpoint.md (69%) rename docs/{web => cmd/www}/meroxa-create-pipeline.md (59%) rename docs/{web => cmd/www}/meroxa-create.md (67%) rename docs/{web => cmd/www}/meroxa-describe-connector.md (56%) rename docs/{web => cmd/www}/meroxa-describe-endpoint.md (56%) rename docs/{web => cmd/www}/meroxa-describe-resource.md (56%) rename docs/{web => cmd/www}/meroxa-describe.md (67%) rename docs/{web => cmd/www}/meroxa-list-connectors.md (58%) rename docs/{web => cmd/www}/meroxa-list-endpoint.md (53%) rename docs/{web => cmd/www}/meroxa-list-pipelines.md (53%) rename docs/{web => cmd/www}/meroxa-list-resource-types.md (56%) rename docs/{web => cmd/www}/meroxa-list-resources.md (53%) rename docs/{web => cmd/www}/meroxa-list-transforms.md (54%) rename docs/{web => cmd/www}/meroxa-list.md (73%) rename docs/{web => cmd/www}/meroxa-login.md (51%) rename docs/{web => cmd/www}/meroxa-logout.md (51%) rename docs/{web => cmd/www}/meroxa-logs-connector.md (55%) rename docs/{web => cmd/www}/meroxa-logs.md (54%) rename docs/{web => cmd/www}/meroxa-open-billing.md (55%) rename docs/{web => cmd/www}/meroxa-open.md (54%) rename docs/{web => cmd/www}/meroxa-remove-connector.md (50%) rename docs/{web => cmd/www}/meroxa-remove-endpoint.md (50%) rename docs/{web => cmd/www}/meroxa-remove-pipeline.md (50%) rename docs/{web => cmd/www}/meroxa-remove-resource.md (50%) rename docs/{web => cmd/www}/meroxa-remove.md (71%) rename docs/{web => cmd/www}/meroxa-update-connector.md (60%) rename docs/{web => cmd/www}/meroxa-update-pipeline.md (70%) rename docs/{web => cmd/www}/meroxa-update-resource.md (68%) rename docs/{web => cmd/www}/meroxa-update.md (66%) rename docs/{web => cmd/www}/meroxa-version.md (51%) rename docs/{web => cmd/www}/meroxa.md (80%) diff --git a/Makefile b/Makefile index 959500f6c..9b4345610 100644 --- a/Makefile +++ b/Makefile @@ -19,6 +19,6 @@ test: .PHONY: docs docs: - rm -rf docs/cmd && mkdir docs/cmd + rm -rf docs/cmd && mkdir -p docs/cmd/{md,www} rm -rf etc && mkdir -p etc/man/man1 && mkdir -p etc/completion go run gen-docs/main.go \ No newline at end of file diff --git a/README.md b/README.md index 885aae979..894e26d08 100644 --- a/README.md +++ b/README.md @@ -85,4 +85,4 @@ make test If you want to enable shell completion manually, you can generate your own using our `meroxa completion` command. -Type `meroxa help completion` for more information, or simply take a look at our [documentation](docs/cmd/meroxa_completion.md). \ No newline at end of file +Type `meroxa help completion` for more information, or simply take a look at our [documentation](docs/cmd/md/meroxa_completion.md). \ No newline at end of file diff --git a/docs/cmd/meroxa.md b/docs/cmd/md/meroxa.md similarity index 100% rename from docs/cmd/meroxa.md rename to docs/cmd/md/meroxa.md diff --git a/docs/cmd/meroxa_add.md b/docs/cmd/md/meroxa_add.md similarity index 100% rename from docs/cmd/meroxa_add.md rename to docs/cmd/md/meroxa_add.md diff --git a/docs/cmd/meroxa_add_resource.md b/docs/cmd/md/meroxa_add_resource.md similarity index 100% rename from docs/cmd/meroxa_add_resource.md rename to docs/cmd/md/meroxa_add_resource.md diff --git a/docs/cmd/meroxa_api.md b/docs/cmd/md/meroxa_api.md similarity index 100% rename from docs/cmd/meroxa_api.md rename to docs/cmd/md/meroxa_api.md diff --git a/docs/cmd/meroxa_billing.md b/docs/cmd/md/meroxa_billing.md similarity index 100% rename from docs/cmd/meroxa_billing.md rename to docs/cmd/md/meroxa_billing.md diff --git a/docs/cmd/meroxa_completion.md b/docs/cmd/md/meroxa_completion.md similarity index 100% rename from docs/cmd/meroxa_completion.md rename to docs/cmd/md/meroxa_completion.md diff --git a/docs/cmd/meroxa_connect.md b/docs/cmd/md/meroxa_connect.md similarity index 100% rename from docs/cmd/meroxa_connect.md rename to docs/cmd/md/meroxa_connect.md diff --git a/docs/cmd/meroxa_create.md b/docs/cmd/md/meroxa_create.md similarity index 100% rename from docs/cmd/meroxa_create.md rename to docs/cmd/md/meroxa_create.md diff --git a/docs/cmd/meroxa_create_connector.md b/docs/cmd/md/meroxa_create_connector.md similarity index 100% rename from docs/cmd/meroxa_create_connector.md rename to docs/cmd/md/meroxa_create_connector.md diff --git a/docs/cmd/meroxa_create_endpoint.md b/docs/cmd/md/meroxa_create_endpoint.md similarity index 100% rename from docs/cmd/meroxa_create_endpoint.md rename to docs/cmd/md/meroxa_create_endpoint.md diff --git a/docs/cmd/meroxa_create_pipeline.md b/docs/cmd/md/meroxa_create_pipeline.md similarity index 100% rename from docs/cmd/meroxa_create_pipeline.md rename to docs/cmd/md/meroxa_create_pipeline.md diff --git a/docs/cmd/meroxa_describe.md b/docs/cmd/md/meroxa_describe.md similarity index 100% rename from docs/cmd/meroxa_describe.md rename to docs/cmd/md/meroxa_describe.md diff --git a/docs/cmd/meroxa_describe_connector.md b/docs/cmd/md/meroxa_describe_connector.md similarity index 100% rename from docs/cmd/meroxa_describe_connector.md rename to docs/cmd/md/meroxa_describe_connector.md diff --git a/docs/cmd/meroxa_describe_endpoint.md b/docs/cmd/md/meroxa_describe_endpoint.md similarity index 100% rename from docs/cmd/meroxa_describe_endpoint.md rename to docs/cmd/md/meroxa_describe_endpoint.md diff --git a/docs/cmd/meroxa_describe_resource.md b/docs/cmd/md/meroxa_describe_resource.md similarity index 100% rename from docs/cmd/meroxa_describe_resource.md rename to docs/cmd/md/meroxa_describe_resource.md diff --git a/docs/cmd/meroxa_list.md b/docs/cmd/md/meroxa_list.md similarity index 100% rename from docs/cmd/meroxa_list.md rename to docs/cmd/md/meroxa_list.md diff --git a/docs/cmd/meroxa_list_connectors.md b/docs/cmd/md/meroxa_list_connectors.md similarity index 100% rename from docs/cmd/meroxa_list_connectors.md rename to docs/cmd/md/meroxa_list_connectors.md diff --git a/docs/cmd/meroxa_list_endpoint.md b/docs/cmd/md/meroxa_list_endpoint.md similarity index 100% rename from docs/cmd/meroxa_list_endpoint.md rename to docs/cmd/md/meroxa_list_endpoint.md diff --git a/docs/cmd/meroxa_list_pipelines.md b/docs/cmd/md/meroxa_list_pipelines.md similarity index 100% rename from docs/cmd/meroxa_list_pipelines.md rename to docs/cmd/md/meroxa_list_pipelines.md diff --git a/docs/cmd/meroxa_list_resource-types.md b/docs/cmd/md/meroxa_list_resource-types.md similarity index 100% rename from docs/cmd/meroxa_list_resource-types.md rename to docs/cmd/md/meroxa_list_resource-types.md diff --git a/docs/cmd/meroxa_list_resources.md b/docs/cmd/md/meroxa_list_resources.md similarity index 100% rename from docs/cmd/meroxa_list_resources.md rename to docs/cmd/md/meroxa_list_resources.md diff --git a/docs/cmd/meroxa_list_transforms.md b/docs/cmd/md/meroxa_list_transforms.md similarity index 100% rename from docs/cmd/meroxa_list_transforms.md rename to docs/cmd/md/meroxa_list_transforms.md diff --git a/docs/cmd/meroxa_login.md b/docs/cmd/md/meroxa_login.md similarity index 100% rename from docs/cmd/meroxa_login.md rename to docs/cmd/md/meroxa_login.md diff --git a/docs/cmd/meroxa_logout.md b/docs/cmd/md/meroxa_logout.md similarity index 100% rename from docs/cmd/meroxa_logout.md rename to docs/cmd/md/meroxa_logout.md diff --git a/docs/cmd/meroxa_logs.md b/docs/cmd/md/meroxa_logs.md similarity index 100% rename from docs/cmd/meroxa_logs.md rename to docs/cmd/md/meroxa_logs.md diff --git a/docs/cmd/meroxa_logs_connector.md b/docs/cmd/md/meroxa_logs_connector.md similarity index 100% rename from docs/cmd/meroxa_logs_connector.md rename to docs/cmd/md/meroxa_logs_connector.md diff --git a/docs/cmd/meroxa_open.md b/docs/cmd/md/meroxa_open.md similarity index 100% rename from docs/cmd/meroxa_open.md rename to docs/cmd/md/meroxa_open.md diff --git a/docs/cmd/meroxa_open_billing.md b/docs/cmd/md/meroxa_open_billing.md similarity index 100% rename from docs/cmd/meroxa_open_billing.md rename to docs/cmd/md/meroxa_open_billing.md diff --git a/docs/cmd/meroxa_remove.md b/docs/cmd/md/meroxa_remove.md similarity index 100% rename from docs/cmd/meroxa_remove.md rename to docs/cmd/md/meroxa_remove.md diff --git a/docs/cmd/meroxa_remove_connector.md b/docs/cmd/md/meroxa_remove_connector.md similarity index 100% rename from docs/cmd/meroxa_remove_connector.md rename to docs/cmd/md/meroxa_remove_connector.md diff --git a/docs/cmd/meroxa_remove_endpoint.md b/docs/cmd/md/meroxa_remove_endpoint.md similarity index 100% rename from docs/cmd/meroxa_remove_endpoint.md rename to docs/cmd/md/meroxa_remove_endpoint.md diff --git a/docs/cmd/meroxa_remove_pipeline.md b/docs/cmd/md/meroxa_remove_pipeline.md similarity index 100% rename from docs/cmd/meroxa_remove_pipeline.md rename to docs/cmd/md/meroxa_remove_pipeline.md diff --git a/docs/cmd/meroxa_remove_resource.md b/docs/cmd/md/meroxa_remove_resource.md similarity index 100% rename from docs/cmd/meroxa_remove_resource.md rename to docs/cmd/md/meroxa_remove_resource.md diff --git a/docs/cmd/meroxa_update.md b/docs/cmd/md/meroxa_update.md similarity index 100% rename from docs/cmd/meroxa_update.md rename to docs/cmd/md/meroxa_update.md diff --git a/docs/cmd/meroxa_update_connector.md b/docs/cmd/md/meroxa_update_connector.md similarity index 100% rename from docs/cmd/meroxa_update_connector.md rename to docs/cmd/md/meroxa_update_connector.md diff --git a/docs/cmd/meroxa_update_pipeline.md b/docs/cmd/md/meroxa_update_pipeline.md similarity index 100% rename from docs/cmd/meroxa_update_pipeline.md rename to docs/cmd/md/meroxa_update_pipeline.md diff --git a/docs/cmd/meroxa_update_resource.md b/docs/cmd/md/meroxa_update_resource.md similarity index 100% rename from docs/cmd/meroxa_update_resource.md rename to docs/cmd/md/meroxa_update_resource.md diff --git a/docs/cmd/meroxa_version.md b/docs/cmd/md/meroxa_version.md similarity index 100% rename from docs/cmd/meroxa_version.md rename to docs/cmd/md/meroxa_version.md diff --git a/docs/web/meroxa-add-resource.md b/docs/cmd/www/meroxa-add-resource.md similarity index 77% rename from docs/web/meroxa-add-resource.md rename to docs/cmd/www/meroxa-add-resource.md index 222da1a1c..49613cdb8 100644 --- a/docs/web/meroxa-add-resource.md +++ b/docs/cmd/www/meroxa-add-resource.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa add resource" slug: meroxa-add-resource url: /cli/meroxa-add-resource/ @@ -41,9 +41,10 @@ meroxa add resource slack --type url -u $WEBHOOK_URL ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-add.md b/docs/cmd/www/meroxa-add.md similarity index 56% rename from docs/web/meroxa-add.md rename to docs/cmd/www/meroxa-add.md index 07939405d..1f6013ed3 100644 --- a/docs/web/meroxa-add.md +++ b/docs/cmd/www/meroxa-add.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa add" slug: meroxa-add url: /cli/meroxa-add/ @@ -18,9 +18,10 @@ Add a resource to your Meroxa resource catalog ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-api.md b/docs/cmd/www/meroxa-api.md similarity index 60% rename from docs/web/meroxa-api.md rename to docs/cmd/www/meroxa-api.md index dca001e0b..03aca9467 100644 --- a/docs/web/meroxa-api.md +++ b/docs/cmd/www/meroxa-api.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa api" slug: meroxa-api url: /cli/meroxa-api/ @@ -30,9 +30,10 @@ meroxa api POST /v1/endpoints '{"protocol": "HTTP", "stream": "resource-2-499379 ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-billing.md b/docs/cmd/www/meroxa-billing.md similarity index 52% rename from docs/web/meroxa-billing.md rename to docs/cmd/www/meroxa-billing.md index 41424ed8c..7d50b3782 100644 --- a/docs/web/meroxa-billing.md +++ b/docs/cmd/www/meroxa-billing.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa billing" slug: meroxa-billing url: /cli/meroxa-billing/ @@ -22,9 +22,10 @@ meroxa billing [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-completion.md b/docs/cmd/www/meroxa-completion.md similarity index 79% rename from docs/web/meroxa-completion.md rename to docs/cmd/www/meroxa-completion.md index c5369aadd..f5ec6c4b4 100644 --- a/docs/web/meroxa-completion.md +++ b/docs/cmd/www/meroxa-completion.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa completion" slug: meroxa-completion url: /cli/meroxa-completion/ @@ -56,9 +56,10 @@ meroxa completion [bash|zsh|fish|powershell] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-connect.md b/docs/cmd/www/meroxa-connect.md similarity index 79% rename from docs/web/meroxa-connect.md rename to docs/cmd/www/meroxa-connect.md index 3d9093f0b..8170fd0cc 100644 --- a/docs/web/meroxa-connect.md +++ b/docs/cmd/www/meroxa-connect.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa connect" slug: meroxa-connect url: /cli/meroxa-connect/ @@ -42,9 +42,10 @@ meroxa connect --from RESOURCE-NAME --to RESOURCE-NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-create-connector.md b/docs/cmd/www/meroxa-create-connector.md similarity index 77% rename from docs/web/meroxa-create-connector.md rename to docs/cmd/www/meroxa-create-connector.md index de17360da..d66731839 100644 --- a/docs/web/meroxa-create-connector.md +++ b/docs/cmd/www/meroxa-create-connector.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa create connector" slug: meroxa-create-connector url: /cli/meroxa-create-connector/ @@ -40,9 +40,10 @@ meroxa create connector [NAME] --to pg2redshift --input orders --pipeline my-pip ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-create-endpoint.md b/docs/cmd/www/meroxa-create-endpoint.md similarity index 69% rename from docs/web/meroxa-create-endpoint.md rename to docs/cmd/www/meroxa-create-endpoint.md index b7cfbf1ef..e4a275021 100644 --- a/docs/web/meroxa-create-endpoint.md +++ b/docs/cmd/www/meroxa-create-endpoint.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa create endpoint" slug: meroxa-create-endpoint url: /cli/meroxa-create-endpoint/ @@ -35,9 +35,10 @@ meroxa create endpoint my-endpoint --protocol http --stream my-stream ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-create-pipeline.md b/docs/cmd/www/meroxa-create-pipeline.md similarity index 59% rename from docs/web/meroxa-create-pipeline.md rename to docs/cmd/www/meroxa-create-pipeline.md index 10c344c76..d2bf7a79f 100644 --- a/docs/web/meroxa-create-pipeline.md +++ b/docs/cmd/www/meroxa-create-pipeline.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa create pipeline" slug: meroxa-create-pipeline url: /cli/meroxa-create-pipeline/ @@ -23,9 +23,10 @@ meroxa create pipeline NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-create.md b/docs/cmd/www/meroxa-create.md similarity index 67% rename from docs/web/meroxa-create.md rename to docs/cmd/www/meroxa-create.md index 9e79be82e..a2af68c42 100644 --- a/docs/web/meroxa-create.md +++ b/docs/cmd/www/meroxa-create.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa create" slug: meroxa-create url: /cli/meroxa-create/ @@ -23,9 +23,10 @@ including connectors. ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-describe-connector.md b/docs/cmd/www/meroxa-describe-connector.md similarity index 56% rename from docs/web/meroxa-describe-connector.md rename to docs/cmd/www/meroxa-describe-connector.md index 1c89e709d..28a1f729d 100644 --- a/docs/web/meroxa-describe-connector.md +++ b/docs/cmd/www/meroxa-describe-connector.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa describe connector" slug: meroxa-describe-connector url: /cli/meroxa-describe-connector/ @@ -22,9 +22,10 @@ meroxa describe connector [name] [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-describe-endpoint.md b/docs/cmd/www/meroxa-describe-endpoint.md similarity index 56% rename from docs/web/meroxa-describe-endpoint.md rename to docs/cmd/www/meroxa-describe-endpoint.md index 9d1430011..260f88dc6 100644 --- a/docs/web/meroxa-describe-endpoint.md +++ b/docs/cmd/www/meroxa-describe-endpoint.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa describe endpoint" slug: meroxa-describe-endpoint url: /cli/meroxa-describe-endpoint/ @@ -22,9 +22,10 @@ meroxa describe endpoint NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-describe-resource.md b/docs/cmd/www/meroxa-describe-resource.md similarity index 56% rename from docs/web/meroxa-describe-resource.md rename to docs/cmd/www/meroxa-describe-resource.md index 1e62e18fe..3bfdc6a40 100644 --- a/docs/web/meroxa-describe-resource.md +++ b/docs/cmd/www/meroxa-describe-resource.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa describe resource" slug: meroxa-describe-resource url: /cli/meroxa-describe-resource/ @@ -22,9 +22,10 @@ meroxa describe resource NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-describe.md b/docs/cmd/www/meroxa-describe.md similarity index 67% rename from docs/web/meroxa-describe.md rename to docs/cmd/www/meroxa-describe.md index 1348f2126..0f1874d86 100644 --- a/docs/web/meroxa-describe.md +++ b/docs/cmd/www/meroxa-describe.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa describe" slug: meroxa-describe url: /cli/meroxa-describe/ @@ -22,9 +22,10 @@ Describe a component of the Meroxa data platform, including resources and connec ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-list-connectors.md b/docs/cmd/www/meroxa-list-connectors.md similarity index 58% rename from docs/web/meroxa-list-connectors.md rename to docs/cmd/www/meroxa-list-connectors.md index 52afed9cd..fa5dd9683 100644 --- a/docs/web/meroxa-list-connectors.md +++ b/docs/cmd/www/meroxa-list-connectors.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa list connectors" slug: meroxa-list-connectors url: /cli/meroxa-list-connectors/ @@ -23,9 +23,10 @@ meroxa list connectors [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-list-endpoint.md b/docs/cmd/www/meroxa-list-endpoint.md similarity index 53% rename from docs/web/meroxa-list-endpoint.md rename to docs/cmd/www/meroxa-list-endpoint.md index 15b389361..d701bbe65 100644 --- a/docs/web/meroxa-list-endpoint.md +++ b/docs/cmd/www/meroxa-list-endpoint.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa list endpoint" slug: meroxa-list-endpoint url: /cli/meroxa-list-endpoint/ @@ -22,9 +22,10 @@ meroxa list endpoint [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-list-pipelines.md b/docs/cmd/www/meroxa-list-pipelines.md similarity index 53% rename from docs/web/meroxa-list-pipelines.md rename to docs/cmd/www/meroxa-list-pipelines.md index a9693008f..5c0d3c49f 100644 --- a/docs/web/meroxa-list-pipelines.md +++ b/docs/cmd/www/meroxa-list-pipelines.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa list pipelines" slug: meroxa-list-pipelines url: /cli/meroxa-list-pipelines/ @@ -22,9 +22,10 @@ meroxa list pipelines [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-list-resource-types.md b/docs/cmd/www/meroxa-list-resource-types.md similarity index 56% rename from docs/web/meroxa-list-resource-types.md rename to docs/cmd/www/meroxa-list-resource-types.md index b42788c5b..ce24f4d52 100644 --- a/docs/web/meroxa-list-resource-types.md +++ b/docs/cmd/www/meroxa-list-resource-types.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa list resource-types" slug: meroxa-list-resource-types url: /cli/meroxa-list-resource-types/ @@ -22,9 +22,10 @@ meroxa list resource-types [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-list-resources.md b/docs/cmd/www/meroxa-list-resources.md similarity index 53% rename from docs/web/meroxa-list-resources.md rename to docs/cmd/www/meroxa-list-resources.md index ffb04fd16..fc32e0fa7 100644 --- a/docs/web/meroxa-list-resources.md +++ b/docs/cmd/www/meroxa-list-resources.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa list resources" slug: meroxa-list-resources url: /cli/meroxa-list-resources/ @@ -22,9 +22,10 @@ meroxa list resources [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-list-transforms.md b/docs/cmd/www/meroxa-list-transforms.md similarity index 54% rename from docs/web/meroxa-list-transforms.md rename to docs/cmd/www/meroxa-list-transforms.md index d70cc4dba..75027c095 100644 --- a/docs/web/meroxa-list-transforms.md +++ b/docs/cmd/www/meroxa-list-transforms.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa list transforms" slug: meroxa-list-transforms url: /cli/meroxa-list-transforms/ @@ -22,9 +22,10 @@ meroxa list transforms [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-list.md b/docs/cmd/www/meroxa-list.md similarity index 73% rename from docs/web/meroxa-list.md rename to docs/cmd/www/meroxa-list.md index 599b62e7f..983be042a 100644 --- a/docs/web/meroxa-list.md +++ b/docs/cmd/www/meroxa-list.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa list" slug: meroxa-list url: /cli/meroxa-list/ @@ -23,9 +23,10 @@ List the components of the Meroxa platform, including pipelines, ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-login.md b/docs/cmd/www/meroxa-login.md similarity index 51% rename from docs/web/meroxa-login.md rename to docs/cmd/www/meroxa-login.md index 6b053eff6..d0f59ea91 100644 --- a/docs/web/meroxa-login.md +++ b/docs/cmd/www/meroxa-login.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa login" slug: meroxa-login url: /cli/meroxa-login/ @@ -22,9 +22,10 @@ meroxa login [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-logout.md b/docs/cmd/www/meroxa-logout.md similarity index 51% rename from docs/web/meroxa-logout.md rename to docs/cmd/www/meroxa-logout.md index 6529ef267..edfc3a625 100644 --- a/docs/web/meroxa-logout.md +++ b/docs/cmd/www/meroxa-logout.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa logout" slug: meroxa-logout url: /cli/meroxa-logout/ @@ -22,9 +22,10 @@ meroxa logout [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-logs-connector.md b/docs/cmd/www/meroxa-logs-connector.md similarity index 55% rename from docs/web/meroxa-logs-connector.md rename to docs/cmd/www/meroxa-logs-connector.md index 61e99eb84..178f072f1 100644 --- a/docs/web/meroxa-logs-connector.md +++ b/docs/cmd/www/meroxa-logs-connector.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa logs connector" slug: meroxa-logs-connector url: /cli/meroxa-logs-connector/ @@ -22,9 +22,10 @@ meroxa logs connector NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-logs.md b/docs/cmd/www/meroxa-logs.md similarity index 54% rename from docs/web/meroxa-logs.md rename to docs/cmd/www/meroxa-logs.md index 89f0cb0e8..55b5d57ce 100644 --- a/docs/web/meroxa-logs.md +++ b/docs/cmd/www/meroxa-logs.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa logs" slug: meroxa-logs url: /cli/meroxa-logs/ @@ -18,9 +18,10 @@ Print logs for a component ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-open-billing.md b/docs/cmd/www/meroxa-open-billing.md similarity index 55% rename from docs/web/meroxa-open-billing.md rename to docs/cmd/www/meroxa-open-billing.md index 2448dba63..db8a544ff 100644 --- a/docs/web/meroxa-open-billing.md +++ b/docs/cmd/www/meroxa-open-billing.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa open billing" slug: meroxa-open-billing url: /cli/meroxa-open-billing/ @@ -22,9 +22,10 @@ meroxa open billing [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-open.md b/docs/cmd/www/meroxa-open.md similarity index 54% rename from docs/web/meroxa-open.md rename to docs/cmd/www/meroxa-open.md index 1912c70f5..e7e47bf9d 100644 --- a/docs/web/meroxa-open.md +++ b/docs/cmd/www/meroxa-open.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa open" slug: meroxa-open url: /cli/meroxa-open/ @@ -18,9 +18,10 @@ Open in a web browser ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-remove-connector.md b/docs/cmd/www/meroxa-remove-connector.md similarity index 50% rename from docs/web/meroxa-remove-connector.md rename to docs/cmd/www/meroxa-remove-connector.md index a179c538c..136e495fd 100644 --- a/docs/web/meroxa-remove-connector.md +++ b/docs/cmd/www/meroxa-remove-connector.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa remove connector" slug: meroxa-remove-connector url: /cli/meroxa-remove-connector/ @@ -22,10 +22,11 @@ meroxa remove connector NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - -f, --force force delete without confirmation prompt - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -f, --force force delete without confirmation prompt + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-remove-endpoint.md b/docs/cmd/www/meroxa-remove-endpoint.md similarity index 50% rename from docs/web/meroxa-remove-endpoint.md rename to docs/cmd/www/meroxa-remove-endpoint.md index 914632901..98baf62ac 100644 --- a/docs/web/meroxa-remove-endpoint.md +++ b/docs/cmd/www/meroxa-remove-endpoint.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa remove endpoint" slug: meroxa-remove-endpoint url: /cli/meroxa-remove-endpoint/ @@ -22,10 +22,11 @@ meroxa remove endpoint NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - -f, --force force delete without confirmation prompt - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -f, --force force delete without confirmation prompt + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-remove-pipeline.md b/docs/cmd/www/meroxa-remove-pipeline.md similarity index 50% rename from docs/web/meroxa-remove-pipeline.md rename to docs/cmd/www/meroxa-remove-pipeline.md index 25e146d7d..fa2f2cea0 100644 --- a/docs/web/meroxa-remove-pipeline.md +++ b/docs/cmd/www/meroxa-remove-pipeline.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa remove pipeline" slug: meroxa-remove-pipeline url: /cli/meroxa-remove-pipeline/ @@ -22,10 +22,11 @@ meroxa remove pipeline NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - -f, --force force delete without confirmation prompt - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -f, --force force delete without confirmation prompt + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-remove-resource.md b/docs/cmd/www/meroxa-remove-resource.md similarity index 50% rename from docs/web/meroxa-remove-resource.md rename to docs/cmd/www/meroxa-remove-resource.md index ee8226f95..02842856a 100644 --- a/docs/web/meroxa-remove-resource.md +++ b/docs/cmd/www/meroxa-remove-resource.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa remove resource" slug: meroxa-remove-resource url: /cli/meroxa-remove-resource/ @@ -22,10 +22,11 @@ meroxa remove resource NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - -f, --force force delete without confirmation prompt - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -f, --force force delete without confirmation prompt + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-remove.md b/docs/cmd/www/meroxa-remove.md similarity index 71% rename from docs/web/meroxa-remove.md rename to docs/cmd/www/meroxa-remove.md index cfb23e5df..8ecb6f17c 100644 --- a/docs/web/meroxa-remove.md +++ b/docs/cmd/www/meroxa-remove.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa remove" slug: meroxa-remove url: /cli/meroxa-remove/ @@ -24,9 +24,10 @@ Deprovision a component of the Meroxa platform, including pipelines, ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-update-connector.md b/docs/cmd/www/meroxa-update-connector.md similarity index 60% rename from docs/web/meroxa-update-connector.md rename to docs/cmd/www/meroxa-update-connector.md index 9654b36a0..942ff25e5 100644 --- a/docs/web/meroxa-update-connector.md +++ b/docs/cmd/www/meroxa-update-connector.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa update connector" slug: meroxa-update-connector url: /cli/meroxa-update-connector/ @@ -23,9 +23,10 @@ meroxa update connector NAME --state pause | resume | restart [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-update-pipeline.md b/docs/cmd/www/meroxa-update-pipeline.md similarity index 70% rename from docs/web/meroxa-update-pipeline.md rename to docs/cmd/www/meroxa-update-pipeline.md index 57f5a9049..739f5cd4e 100644 --- a/docs/web/meroxa-update-pipeline.md +++ b/docs/cmd/www/meroxa-update-pipeline.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa update pipeline" slug: meroxa-update-pipeline url: /cli/meroxa-update-pipeline/ @@ -34,9 +34,10 @@ meroxa update pipeline pipeline-name --metadata '{"key":"value"}' ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-update-resource.md b/docs/cmd/www/meroxa-update-resource.md similarity index 68% rename from docs/web/meroxa-update-resource.md rename to docs/cmd/www/meroxa-update-resource.md index 424f9b508..14049e8cc 100644 --- a/docs/web/meroxa-update-resource.md +++ b/docs/cmd/www/meroxa-update-resource.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa update resource" slug: meroxa-update-resource url: /cli/meroxa-update-resource/ @@ -30,9 +30,10 @@ meroxa update resource NAME [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-update.md b/docs/cmd/www/meroxa-update.md similarity index 66% rename from docs/web/meroxa-update.md rename to docs/cmd/www/meroxa-update.md index a75223ac1..4b3baaed5 100644 --- a/docs/web/meroxa-update.md +++ b/docs/cmd/www/meroxa-update.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa update" slug: meroxa-update url: /cli/meroxa-update/ @@ -22,9 +22,10 @@ Update a component of the Meroxa platform, including connectors ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa-version.md b/docs/cmd/www/meroxa-version.md similarity index 51% rename from docs/web/meroxa-version.md rename to docs/cmd/www/meroxa-version.md index 126e853e2..2cf758329 100644 --- a/docs/web/meroxa-version.md +++ b/docs/cmd/www/meroxa-version.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa version" slug: meroxa-version url: /cli/meroxa-version/ @@ -22,9 +22,10 @@ meroxa version [flags] ### Options inherited from parent commands ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/docs/web/meroxa.md b/docs/cmd/www/meroxa.md similarity index 80% rename from docs/web/meroxa.md rename to docs/cmd/www/meroxa.md index 233fa4b09..2a527f352 100644 --- a/docs/web/meroxa.md +++ b/docs/cmd/www/meroxa.md @@ -1,6 +1,6 @@ --- -createdAt: 2021-04-14T11:24:43-04:00 -updatedAt: 2021-04-14T11:24:43-04:00 +createdAt: 2021-04-15T17:48:51+02:00 +updatedAt: 2021-04-15T17:48:51+02:00 title: "meroxa" slug: meroxa url: /cli/meroxa/ @@ -22,10 +22,11 @@ meroxa list resource-types ### Options ``` - --config string config file (default is $HOME/meroxa.env) - --debug display any debugging information - -h, --help help for meroxa - --json output json + --config string config file (default is $HOME/meroxa.env) + --debug display any debugging information + -h, --help help for meroxa + --json output json + --timeout duration set the client timeout (default 10s) ``` ### SEE ALSO diff --git a/gen-docs/main.go b/gen-docs/main.go index 6ce2e457c..e53e97288 100644 --- a/gen-docs/main.go +++ b/gen-docs/main.go @@ -2,6 +2,8 @@ package main import ( "fmt" + cmd "github.com/meroxa/cli/cmd" + "github.com/spf13/cobra" "log" "os" "path" @@ -9,8 +11,6 @@ import ( "strings" "time" - cmd "github.com/meroxa/cli/cmd" - "github.com/spf13/cobra/doc" ) @@ -45,13 +45,7 @@ func renameFromUnderscoreToDash(dir string) { } } -func main() { - // set HOME env var so that default values involve user's home directory do not depend on the running user. - os.Setenv("HOME", "/home/user") - - rootCmd := cmd.RootCmd() - - // Generating Man Pages +func generateManPages(rootCmd *cobra.Command) error { header := &doc.GenManHeader{ Title: "Meroxa", Section: "1", @@ -59,16 +53,14 @@ func main() { Manual: "Meroxa Manual", } - if err := doc.GenManTree(rootCmd, header, "./etc/man/man1"); err != nil { - log.Fatal(err) - } + return doc.GenManTree(rootCmd, header, "./etc/man/man1") +} - // Generating Markdown Documents - err := doc.GenMarkdownTree(rootCmd, "./docs/cmd") - if err != nil { - log.Fatal(err) - } +func generateMarkdownPages(rootCmd *cobra.Command) error { + return doc.GenMarkdownTree(rootCmd, "./docs/cmd/md") +} +func generateDocsDotComPages(rootCmd *cobra.Command) error { filePrepender := func(filename string) string { createdAt := time.Now().Format(time.RFC3339) name := filepath.Base(filename) @@ -84,14 +76,10 @@ func main() { return "/cli/" + strings.ToLower(slug) + "/" } - // Generating Markdown Documents - errWeb := doc.GenMarkdownTreeCustom(rootCmd, "./docs/web", filePrepender, linkHandler) - if errWeb != nil { - log.Fatal(err) - } - - renameFromUnderscoreToDash("./docs/web") + return doc.GenMarkdownTreeCustom(rootCmd, "./docs/cmd/www", filePrepender, linkHandler) +} +func generateShellCompletionFiles(rootCmd *cobra.Command) { // Generating Bash Completion File if err := rootCmd.GenBashCompletionFile("./etc/completion/meroxa.completion.sh"); err != nil { log.Fatal(err) @@ -122,3 +110,26 @@ func main() { log.Fatal(err) } } + +func main() { + // set HOME env var so that default values involve user's home directory do not depend on the running user. + os.Setenv("HOME", "/home/user") + + rootCmd := cmd.RootCmd() + + if err := generateManPages(rootCmd); err != nil { + log.Fatal(err) + } + + if err := generateMarkdownPages(rootCmd); err != nil { + log.Fatal(err) + } + + if err := generateDocsDotComPages(rootCmd); err != nil { + log.Fatal(err) + } else { + renameFromUnderscoreToDash("./docs/cmd/www") + } + + generateShellCompletionFiles(rootCmd) +} diff --git a/vendor/github.com/meroxa/meroxa-go/debug.go b/vendor/github.com/meroxa/meroxa-go/debug.go index 86f951bc0..e37a6b01c 100644 --- a/vendor/github.com/meroxa/meroxa-go/debug.go +++ b/vendor/github.com/meroxa/meroxa-go/debug.go @@ -1,9 +1,11 @@ package meroxa import ( + "context" "log" "net/http" "net/http/httputil" + "strings" ) type DumpTransport struct { @@ -11,7 +13,14 @@ type DumpTransport struct { } func (d *DumpTransport) RoundTrip(h *http.Request) (*http.Response, error) { - dump, err := httputil.DumpRequestOut(h, true) + cloned := h.Clone(context.Background()) + + // Makes sure we don't log out the bearer token by accident when it's not nil + if !strings.Contains(cloned.Header.Get("Authorization"), "nil") { + cloned.Header.Set("Authorization", "REDACTED") + } + + dump, err := httputil.DumpRequestOut(cloned, true) if err != nil { return nil, err diff --git a/vendor/modules.txt b/vendor/modules.txt index d6525f518..3b21604b7 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -42,7 +42,7 @@ github.com/mattn/go-isatty # github.com/mattn/go-runewidth v0.0.10 ## explicit github.com/mattn/go-runewidth -# github.com/meroxa/meroxa-go v0.0.0-20210413105822-b2f2f2377003 +# github.com/meroxa/meroxa-go v0.0.0-20210415113807-636e4587ce24 ## explicit github.com/meroxa/meroxa-go # github.com/mitchellh/go-homedir v1.1.0