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

# timoni mod show readme

> Output the README.md of a module

## Synopsis

The readme command prints the README.md file of a module to stdout.
The module can be a local directory or an OCI artifact.

```
timoni mod show readme [MODULE PATH | MODULE URL] [flags]
```

## Examples

```sh theme={"system"}
  # print the readme of a module in the current directory
  timoni mod show readme

  # print the readme of a module published to a container registry
  timoni mod show readme oci://docker.io/org/app -v 1.0.0

```

## Options

```
      --creds creds       The credentials for the container registry in the format '<username>[:<password>]'.
  -h, --help              help for readme
  -v, --version version   The version of the module e.g. '1.0.0' or '1.0.0-rc.1'.
```

## Options inherited from parent commands

```
      --cache-dir string                    Artifacts cache dir, can be disable with 'TIMONI_CACHING=false' env var. (defaults to "$HOME/.timoni/cache")
      --kube-as string                      Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
      --kube-as-group stringArray           Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
      --kube-as-uid string                  UID to impersonate for the operation.
      --kube-certificate-authority string   Path to a cert file for the certificate authority.
      --kube-client-certificate string      Path to a client certificate file for TLS.
      --kube-client-key string              Path to a client key file for TLS.
      --kube-context string                 The name of the kubeconfig context to use.
      --kube-insecure-skip-tls-verify       if true, the Kubernetes API server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
      --kube-server string                  The address and port of the Kubernetes API server.
      --kube-tls-server-name string         Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used.
      --kube-token string                   Bearer token for authentication to the API server.
      --kubeconfig string                   Path to the kubeconfig file.
      --log-color                           Adds colorized output to the logs. (defaults to false when no tty)
      --log-pretty                          Adds timestamps to the logs. (default true)
  -n, --namespace string                    The the namespace scope for the operation. (default "default")
      --registry-insecure                   If true, allows connecting to a container registry without TLS or with a self-signed certificate.
      --timeout duration                    The length of time to wait before giving up on the current operation. (default 5m0s)
```

## See also

* [timoni mod show](/cmd/timoni_mod_show)	 - Commands for showing module information