Skip to content

Commit

Permalink
chore: document meroxa build commands (#322)
Browse files Browse the repository at this point in the history
  • Loading branch information
raulb authored Apr 18, 2022
1 parent 95764c1 commit d7d3c90
Show file tree
Hide file tree
Showing 14 changed files with 441 additions and 7 deletions.
7 changes: 1 addition & 6 deletions cmd/meroxa/root/builds/builds.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import (
var (
_ builder.CommandWithDocs = (*Builds)(nil)
_ builder.CommandWithAliases = (*Builds)(nil)
_ builder.CommandWithHidden = (*Builds)(nil)
_ builder.CommandWithSubCommands = (*Builds)(nil)
)

Expand All @@ -39,13 +38,9 @@ func (*Builds) Aliases() []string {
return []string{"build"}
}

func (*Builds) Hidden() bool {
return true
}

func (*Builds) Docs() builder.Docs {
return builder.Docs{
Short: "Manage Process Builds on Meroxa",
Short: "Inspect Process Builds on Meroxa",
}
}

Expand Down
1 change: 1 addition & 0 deletions docs/cmd/md/meroxa.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ meroxa resources list --types
* [meroxa apps](meroxa_apps.md) - Manage Meroxa Data Applications
* [meroxa auth](meroxa_auth.md) - Authentication commands for Meroxa
* [meroxa billing](meroxa_billing.md) - Open your billing page in a web browser
* [meroxa builds](meroxa_builds.md) - Inspect Process Builds on Meroxa
* [meroxa completion](meroxa_completion.md) - Generate completion script
* [meroxa config](meroxa_config.md) - Manage your Meroxa CLI configuration
* [meroxa endpoints](meroxa_endpoints.md) - Manage endpoints on Meroxa
Expand Down
25 changes: 25 additions & 0 deletions docs/cmd/md/meroxa_builds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## meroxa builds

Inspect Process Builds on Meroxa

### Options

```
-h, --help help for builds
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa](meroxa.md) - The Meroxa CLI
* [meroxa builds describe](meroxa_builds_describe.md) - Describe a Meroxa Process Build
* [meroxa builds logs](meroxa_builds_logs.md) - List a Meroxa Process Build's Logs

27 changes: 27 additions & 0 deletions docs/cmd/md/meroxa_builds_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## meroxa builds describe

Describe a Meroxa Process Build

```
meroxa builds describe [UUID] [flags]
```

### Options

```
-h, --help help for describe
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa builds](meroxa_builds.md) - Inspect Process Builds on Meroxa

27 changes: 27 additions & 0 deletions docs/cmd/md/meroxa_builds_logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## meroxa builds logs

List a Meroxa Process Build's Logs

```
meroxa builds logs [UUID] [flags]
```

### Options

```
-h, --help help for logs
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa builds](meroxa_builds.md) - Inspect Process Builds on Meroxa

34 changes: 34 additions & 0 deletions docs/cmd/www/meroxa-builds-describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
createdAt:
updatedAt:
title: "meroxa builds describe"
slug: meroxa-builds-describe
url: /cli/cmd/meroxa-builds-describe/
---
## meroxa builds describe

Describe a Meroxa Process Build

```
meroxa builds describe [UUID] [flags]
```

### Options

```
-h, --help help for describe
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa builds](/cli/cmd/meroxa-builds/) - Inspect Process Builds on Meroxa

34 changes: 34 additions & 0 deletions docs/cmd/www/meroxa-builds-logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
createdAt:
updatedAt:
title: "meroxa builds logs"
slug: meroxa-builds-logs
url: /cli/cmd/meroxa-builds-logs/
---
## meroxa builds logs

List a Meroxa Process Build's Logs

```
meroxa builds logs [UUID] [flags]
```

### Options

```
-h, --help help for logs
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa builds](/cli/cmd/meroxa-builds/) - Inspect Process Builds on Meroxa

32 changes: 32 additions & 0 deletions docs/cmd/www/meroxa-builds.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
createdAt:
updatedAt:
title: "meroxa builds"
slug: meroxa-builds
url: /cli/cmd/meroxa-builds/
---
## meroxa builds

Inspect Process Builds on Meroxa

### Options

```
-h, --help help for builds
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa](/cli/cmd/meroxa/) - The Meroxa CLI
* [meroxa builds describe](/cli/cmd/meroxa-builds-describe/) - Describe a Meroxa Process Build
* [meroxa builds logs](/cli/cmd/meroxa-builds-logs/) - List a Meroxa Process Build's Logs

1 change: 1 addition & 0 deletions docs/cmd/www/meroxa.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ meroxa resources list --types
* [meroxa apps](/cli/cmd/meroxa-apps/) - Manage Meroxa Data Applications
* [meroxa auth](/cli/cmd/meroxa-auth/) - Authentication commands for Meroxa
* [meroxa billing](/cli/cmd/meroxa-billing/) - Open your billing page in a web browser
* [meroxa builds](/cli/cmd/meroxa-builds/) - Inspect Process Builds on Meroxa
* [meroxa completion](/cli/cmd/meroxa-completion/) - Generate completion script
* [meroxa config](/cli/cmd/meroxa-config/) - Manage your Meroxa CLI configuration
* [meroxa endpoints](/cli/cmd/meroxa-endpoints/) - Manage endpoints on Meroxa
Expand Down
123 changes: 123 additions & 0 deletions etc/completion/meroxa.completion.sh
Original file line number Diff line number Diff line change
Expand Up @@ -812,6 +812,124 @@ _meroxa_billing()
noun_aliases=()
}

_meroxa_builds_describe()
{
last_command="meroxa_builds_describe"

command_aliases=()

commands=()

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--help")
flags+=("-h")
flags+=("--cli-config-file=")
two_word_flags+=("--cli-config-file")
flags+=("--debug")
flags+=("--json")
flags+=("--timeout=")
two_word_flags+=("--timeout")

must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}

_meroxa_builds_help()
{
last_command="meroxa_builds_help"

command_aliases=()

commands=()

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--cli-config-file=")
two_word_flags+=("--cli-config-file")
flags+=("--debug")
flags+=("--json")
flags+=("--timeout=")
two_word_flags+=("--timeout")

must_have_one_flag=()
must_have_one_noun=()
has_completion_function=1
noun_aliases=()
}

_meroxa_builds_logs()
{
last_command="meroxa_builds_logs"

command_aliases=()

commands=()

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--help")
flags+=("-h")
flags+=("--cli-config-file=")
two_word_flags+=("--cli-config-file")
flags+=("--debug")
flags+=("--json")
flags+=("--timeout=")
two_word_flags+=("--timeout")

must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}

_meroxa_builds()
{
last_command="meroxa_builds"

command_aliases=()

commands=()
commands+=("describe")
commands+=("help")
commands+=("logs")
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
command_aliases+=("log")
aliashash["log"]="logs"
fi

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--help")
flags+=("-h")
flags+=("--cli-config-file=")
two_word_flags+=("--cli-config-file")
flags+=("--debug")
flags+=("--json")
flags+=("--timeout=")
two_word_flags+=("--timeout")

must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}

_meroxa_completion()
{
last_command="meroxa_completion"
Expand Down Expand Up @@ -2042,6 +2160,11 @@ _meroxa_root_command()
fi
commands+=("auth")
commands+=("billing")
commands+=("builds")
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
command_aliases+=("build")
aliashash["build"]="builds"
fi
commands+=("completion")
commands+=("config")
if [[ -z "${BASH_VERSION}" || "${BASH_VERSINFO[0]}" -gt 3 ]]; then
Expand Down
Loading

0 comments on commit d7d3c90

Please sign in to comment.