> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ubiquex.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ubx docs

> Open or list resource type documentation.

`ubx docs` opens the documentation URL for a resource type in your browser, or lists its fields in the terminal.

## Usage

```bash theme={null}
ubx docs <resource_type> [flags]
```

## Examples

```bash theme={null}
ubx docs aws_s3_bucket_v2            # open docs in browser
ubx docs aws_rds_instance --list     # list all fields in terminal
ubx docs aws_eks_cluster --list
```

## Flags

| Flag     | Description                                                |
| -------- | ---------------------------------------------------------- |
| `--list` | List all fields in the terminal instead of opening browser |

## `--list` Output

```bash theme={null}
ubx docs aws_s3_bucket_v2 --list
```

```
aws_s3_bucket_v2
  Required:
    (none)

  Optional:
    acceleration_status          string
    acl                          string
    bucket                       string
    bucket_prefix                string
    force_destroy                bool
    object_lock_enabled          bool
    policy                       string
    request_payer                string
    tags                         object
    ...

34 fields  ·  https://index.ubiquex.io/resources/aws_s3_bucket_v2
```

## Browser URL

For unknown resource types, ubx prints the URL and exits 0:

```
https://index.ubiquex.io/resources/aws_s3_bucket_v2
```