akka specify docs

Show where the generated project documentation is, and optionally open it.

Synopsis

Locate the rendered project documentation produced by the /akka:docs command.

/akka:docs generates a self-contained docs/index.html — a component reference with entity and interaction diagrams — into the project’s docs/ folder. This command prints its location and, with --open, opens it in your default browser.

akka specify docs [flags]

Options

      --dir string   project directory (default: current)
  -h, --help         help for docs
      --open         open the documentation in your default browser

Options inherited from parent commands

      --cache-file string   location of cache file (default "~/.akka/cache.yaml")
      --config string       location of config file (default "~/.akka/config.yaml")
      --context string      configuration context to use
      --disable-prompt      Disable all interactive prompts when running akka commands. If input is required, defaults will be used, or an error will be raised.
                            This is equivalent to setting the environment variable AKKA_DISABLE_PROMPTS to true.
  -o, --output string       set output format to one of [text,json,json-compact,go-template=] (default "text")
      --page-mode string    the mode for paging, either paged, buffered or auto. (default "auto")
  -q, --quiet               set quiet output (helpful when used as part of a script)
      --timeout duration    client command timeout (default 10s)
      --use-grpc-web        use grpc-web when talking to Akka APIs. This is useful when behind corporate firewalls that decrypt traffic but don't support HTTP/2.
      --verbose             set verbose output

SEE ALSO

  • akka specify - [Incubating] Initialize and manage AI-assisted Akka development projects.