Skip to content
This repository has been archived by the owner on Mar 16, 2024. It is now read-only.

Commit

Permalink
Add CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cjellick committed Jun 3, 2022
1 parent ab22dcb commit 112d675
Show file tree
Hide file tree
Showing 28 changed files with 1,074 additions and 2 deletions.
2 changes: 0 additions & 2 deletions docs/docs/100-Reference/01-command-line/.gitignore

This file was deleted.

49 changes: 49 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: "acorn"
---
## acorn



### Synopsis

Acorn: Containerized Application Packaging Framework

```
acorn [flags]
```

### Options

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
-h, --help help for acorn
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
```

### SEE ALSO

* [acorn all](acorn_all.md) - List (almost) all objects
* [acorn app](acorn_app.md) - List or get apps
* [acorn build](acorn_build.md) - Build an app from a acorn.cue file
* [acorn container](acorn_container.md) - List or get running containers
* [acorn credential](acorn_credential.md) - Manage registry credentials
* [acorn dev](acorn_dev.md) - Build and run an app in development mode
* [acorn exec](acorn_exec.md) - Run a command in a container
* [acorn image](acorn_image.md) - List images
* [acorn init](acorn_init.md) - Initial cluster for acorn use
* [acorn logs](acorn_logs.md) - Log all pods from app
* [acorn pull](acorn_pull.md) - Pull an image to a remote registry
* [acorn push](acorn_push.md) - Push an image to a remote registry
* [acorn rm](acorn_rm.md) - Delete an app, container, or volume
* [acorn run](acorn_run.md) - Run an app from an app image
* [acorn secret](acorn_secret.md) - Manage secrets
* [acorn start](acorn_start.md) - Start an app
* [acorn stop](acorn_stop.md) - Stop an app
* [acorn tag](acorn_tag.md) - Tag an image
* [acorn update](acorn_update.md) - Update a deployed app
* [acorn volume](acorn_volume.md) - List or get volumes

###### Auto generated by spf13/cobra on 3-Jun-2022
41 changes: 41 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn_all.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "acorn all"
---
## acorn all

List (almost) all objects

```
acorn all [flags]
```

### Examples

```
acorn all
```

### Options

```
-h, --help help for all
-i, --images Include images in output
-o, --output string Output format (json, yaml, {{gotemplate}})
-q, --quiet Output only names
```

### Options inherited from parent commands

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
```

### SEE ALSO

* [acorn](acorn.md) -

###### Auto generated by spf13/cobra on 3-Jun-2022
40 changes: 40 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn_app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "acorn app"
---
## acorn app

List or get apps

```
acorn app [flags] [APP_NAME...]
```

### Examples

```
acorn app
```

### Options

```
-h, --help help for app
-o, --output string Output format (json, yaml, {{gotemplate}})
-q, --quiet Output only names
```

### Options inherited from parent commands

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
```

### SEE ALSO

* [acorn](acorn.md) -

###### Auto generated by spf13/cobra on 3-Jun-2022
46 changes: 46 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn_build.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: "acorn build"
---
## acorn build

Build an app from a acorn.cue file

### Synopsis

Build all dependent container and app images from your acorn.cue file

```
acorn build [flags] DIRECTORY
```

### Examples

```
# Build from acorn.cue file in the local directory
acorn build .
```

### Options

```
-f, --file string Name of the build file (default "DIRECTORY/acorn.cue")
-h, --help help for build
-p, --platforms strings Target platforms (form os/arch[/variant][:osversion] example linux/amd64)
-t, --tag strings Apply a tag to the final build
```

### Options inherited from parent commands

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
```

### SEE ALSO

* [acorn](acorn.md) -

###### Auto generated by spf13/cobra on 3-Jun-2022
40 changes: 40 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn_container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "acorn container"
---
## acorn container

List or get running containers

```
acorn container [flags] [APP_NAME...]
```

### Examples

```
acorn containers
```

### Options

```
-h, --help help for container
-o, --output string Output format (json, yaml, {{gotemplate}})
-q, --quiet Output only names
```

### Options inherited from parent commands

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
```

### SEE ALSO

* [acorn](acorn.md) -

###### Auto generated by spf13/cobra on 3-Jun-2022
42 changes: 42 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn_credential.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "acorn credential"
---
## acorn credential

Manage registry credentials

```
acorn credential [flags] [SERVER_ADDRESS...]
```

### Examples

```
acorn credential
```

### Options

```
-h, --help help for credential
-o, --output string Output format (json, yaml, {{gotemplate}})
-q, --quiet Output only names
```

### Options inherited from parent commands

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
```

### SEE ALSO

* [acorn](acorn.md) -
* [acorn credential login](acorn_credential_login.md) - Add registry credentials
* [acorn credential logout](acorn_credential_logout.md) - Remove registry credentials

###### Auto generated by spf13/cobra on 3-Jun-2022
43 changes: 43 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn_credential_login.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "acorn credential login"
---
## acorn credential login

Add registry credentials

```
acorn credential login [flags] [SERVER_ADDRESS]
```

### Examples

```
acorn login ghcr.io
```

### Options

```
-h, --help help for login
-p, --password string Password
--password-stdin Take the password from stdin
-u, --username string Username
```

### Options inherited from parent commands

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
-o, --output string Output format (json, yaml, {{gotemplate}})
-q, --quiet Output only names
```

### SEE ALSO

* [acorn credential](acorn_credential.md) - Manage registry credentials

###### Auto generated by spf13/cobra on 3-Jun-2022
40 changes: 40 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn_credential_logout.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: "acorn credential logout"
---
## acorn credential logout

Remove registry credentials

```
acorn credential logout [flags] [SERVER_ADDRESS]
```

### Examples

```
acorn logout ghcr.io
```

### Options

```
-h, --help help for logout
```

### Options inherited from parent commands

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
-o, --output string Output format (json, yaml, {{gotemplate}})
-q, --quiet Output only names
```

### SEE ALSO

* [acorn credential](acorn_credential.md) - Manage registry credentials

###### Auto generated by spf13/cobra on 3-Jun-2022
42 changes: 42 additions & 0 deletions docs/docs/100-Reference/01-command-line/acorn_dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "acorn dev"
---
## acorn dev

Build and run an app in development mode

### Synopsis

Build and run an app in development mode

```
acorn dev [flags] DIRECTORY
```

### Options

```
-d, --dns strings Assign a friendly domain to a published container (format public:private) (ex: example.com:web)
-f, --file string Name of the dev file (default "DIRECTORY/acorn.cue")
-h, --help help for dev
-l, --link strings Link external app as a service in the current app (format app-name:service-name)
-n, --name string Name of app to create
-s, --secret strings Bind an existing secret (format existing:sec-name) (ex: sec-name:app-secret)
-v, --volume strings Bind an existing volume (format existing:vol-name) (ex: pvc-name:app-data)
```

### Options inherited from parent commands

```
-A, --all-namespaces Namespace to work in
--context string Context to use in the kubeconfig file
--kubeconfig string Location of a kubeconfig file
--namespace string Namespace to work in (default "acorn")
```

### SEE ALSO

* [acorn](acorn.md) -
* [acorn dev render](acorn_dev_render.md) - Evaluate and display an acorn.cue with deploy params

###### Auto generated by spf13/cobra on 3-Jun-2022
Loading

0 comments on commit 112d675

Please sign in to comment.