Skip to content

Commit

Permalink
Dev/glamorous help (#7)
Browse files Browse the repository at this point in the history
* updates

* replace tables with lipgloss tables
  • Loading branch information
defektive authored Oct 10, 2024
1 parent 2825ec7 commit d740080
Show file tree
Hide file tree
Showing 52 changed files with 695 additions and 717 deletions.
2 changes: 1 addition & 1 deletion .hugo/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ markup:
style: monokai
noClasses: false
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
# guessSyntax: true
guessSyntax: true

# Everything below this are Site Params

Expand Down
56 changes: 55 additions & 1 deletion docs/docs/cli/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,59 @@
---
title: CLI
title: Carbon CLI
description: Carbon CLI Reference
no_list: true
weight: 1
---
## Synopsis

Infrastructure automation for offensive operations.
> Checkout the latest docs [here](https://analog-substance.github.io/carbon/)
> Have a problem? [Create an Issue](https://github.com/analog-substance/carbon/issues/new?title=Something%20is%20broken)
## Purpose
***

Carbon's primary purpose is to provide a consistent execution environment to
facilitate offensive security assessments.

## Dependencies

- Packer to build images.
- Terraform to provision infrastructure.
- Golang project structure.

## Supported Providers

- AWS
- QEMU (Local)
- VirtualBox (Local)
- vSphere (in progress)
- Multipass (Local)

There are plans to bring support to the following:

- GCP
- Azure
- VMware (Local)
- QEMU (Remote)


## Options

```
--config string config file (default is $HOME/.carbon.yaml)
--debug Debug mode
-h, --help help for carbon
-j, --json Output in JSON
```

## SEE ALSO

* [carbon completion](carbon_completion.md) - Generate completion script
* [carbon config](carbon_config.md) - View and manage configuration values.
* [carbon image](carbon_image.md) - View or manage images and image builds.
* [carbon project](carbon_project.md) - Manage and interact with projects
* [carbon update](carbon_update.md) - Update {{.Use}} to latest version
* [carbon vm](carbon_vm.md) - Manage and interact with VMs.

###### Auto generated by spf13/cobra on 10-Oct-2024
45 changes: 0 additions & 45 deletions docs/docs/cli/carbon.md

This file was deleted.

16 changes: 6 additions & 10 deletions docs/docs/cli/carbon_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,7 @@ title: Completion
description: Generate completion script
---

## carbon completion

Generate completion script

### Synopsis
## Synopsis

To load completions:

Expand Down Expand Up @@ -52,22 +48,22 @@ PowerShell:
carbon completion [bash|zsh|fish|powershell]
```

### Options
## Options

```
-h, --help help for completion
```

### Options inherited from parent commands
## Options inherited from parent commands

```
--config string config file (default is $HOME/.carbon.yaml)
--debug Debug mode
-j, --json Output in JSON
```

### SEE ALSO
## SEE ALSO

* [carbon](carbon.md) - Infrastructure Ops simplified
* [carbon](carbon.md) - Carbon - Infrastructure automation for offensive operations.

###### Auto generated by spf13/cobra on 9-Oct-2024
###### Auto generated by spf13/cobra on 10-Oct-2024
60 changes: 41 additions & 19 deletions docs/docs/cli/carbon_config.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,51 @@
---
title: Config
description: Get/Set config information
description: View and manage configuration values.
---

## carbon config
## Synopsis

View and manage configuration values.

Carbon loads configuration files from your home directory, then merges it with
a configuration file in the current directory (if it exists). This should allow
you the flexibility you need.
## Configuration keys
- carbon.default.dir
- carbon.deployments.dir
- carbon.images.dir
- carbon.packer.dir
- carbon.projects.dir
- carbon.providers.aws.enabled
- carbon.providers.aws.profiles.default.enabled
- carbon.providers.multipass.enabled
- carbon.providers.multipass.profiles.default.enabled
- carbon.providers.qemu.enabled
- carbon.providers.qemu.profiles.default.enabled
- carbon.providers.virtualbox.enabled
- carbon.providers.virtualbox.profiles.default.enabled
- carbon.terraform.dir

Get/Set config information

### Synopsis

Get/Set config information.

Set vSphere credentials
```
carbon config [flags]
```

carbon config carbon.credentials.vsphere_server.provider vsphere
carbon config carbon.credentials.vsphere_server.username vsphere_user@vsphere.example
carbon config carbon.credentials.vsphere_server.password_command 'op read op://Private/vSphere Creds/password'
## Examples

```bash
# Configure vSphere credentials
carbon config carbon.credentials.vsphere_server.provider vsphere
carbon config carbon.credentials.vsphere_server.username vsphere_user@vsphere.example
carbon config carbon.credentials.vsphere_server.password_command 'op read op://Private/vSphere Creds/password'
```

```bash
# Set a default project directory
carbon config carbon.default.dir ~/my/path/haxors

```
carbon config [flags]
```

### Options
## Options

```
-h, --help help for config
Expand All @@ -32,16 +54,16 @@ carbon config [flags]
-k, --sub-keys display only the sub-keys
```

### Options inherited from parent commands
## Options inherited from parent commands

```
--config string config file (default is $HOME/.carbon.yaml)
--debug Debug mode
-j, --json Output in JSON
```

### SEE ALSO
## SEE ALSO

* [carbon](carbon.md) - Infrastructure Ops simplified
* [carbon](carbon.md) - Carbon - Infrastructure automation for offensive operations.

###### Auto generated by spf13/cobra on 9-Oct-2024
###### Auto generated by spf13/cobra on 10-Oct-2024
36 changes: 0 additions & 36 deletions docs/docs/cli/carbon_docs.md

This file was deleted.

26 changes: 11 additions & 15 deletions docs/docs/cli/carbon_image.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,32 @@
---
title: Image
description: manage images and image builds
description: View or manage images and image builds.
---

## carbon image
## Synopsis

manage images and image builds
View or manage images and image builds.

### Synopsis

manage images and image builds

### Options
## Options

```
-h, --help help for image
```

### Options inherited from parent commands
## Options inherited from parent commands

```
--config string config file (default is $HOME/.carbon.yaml)
--debug Debug mode
-j, --json Output in JSON
```

### SEE ALSO
## SEE ALSO

* [carbon](carbon.md) - Infrastructure Ops simplified
* [carbon image bootstrap](carbon_image_bootstrap.md) - create image build configs
* [carbon image build](carbon_image_build.md) - build an image
* [carbon image destroy](carbon_image_destroy.md) - destroy/delete images
* [carbon](carbon.md) - Carbon - Infrastructure automation for offensive operations.
* [carbon image bootstrap](carbon_image_bootstrap.md) - Create packer files and other image build configs.
* [carbon image build](carbon_image_build.md) - Build an image.
* [carbon image destroy](carbon_image_destroy.md) - Delete images.
* [carbon image list](carbon_image_list.md) - list images

###### Auto generated by spf13/cobra on 9-Oct-2024
###### Auto generated by spf13/cobra on 10-Oct-2024
31 changes: 14 additions & 17 deletions docs/docs/cli/carbon_image_bootstrap.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,23 @@
---
title: Image Bootstrap
description: create image build configs
description: Create packer files and other image build configs.
---

## carbon image bootstrap

create image build configs

### Synopsis

create image build configs.
Example

carbon image bootstrap -n operator-desktop-aws -s aws -t ubuntu-desktop

## Synopsis

Create packer files and other image build configs.

```
carbon image bootstrap [flags]
```

### Options
## Examples

```bash
carbon image bootstrap -n operator-desktop-aws -s aws -t ubuntu-desktop
```

## Options

```
-h, --help help for bootstrap
Expand All @@ -29,16 +26,16 @@ carbon image bootstrap [flags]
-t, --template string Template to use (default "ubuntu-24.04")
```

### Options inherited from parent commands
## Options inherited from parent commands

```
--config string config file (default is $HOME/.carbon.yaml)
--debug Debug mode
-j, --json Output in JSON
```

### SEE ALSO
## SEE ALSO

* [carbon image](carbon_image.md) - manage images and image builds
* [carbon image](carbon_image.md) - View or manage images and image builds.

###### Auto generated by spf13/cobra on 9-Oct-2024
###### Auto generated by spf13/cobra on 10-Oct-2024
Loading

0 comments on commit d740080

Please sign in to comment.