zio-http-cli
API
Generated with
zio-http-cli/zio.http.endpoint.cli/HttpCliApp

HttpCliApp

zio.http.endpoint.cli.HttpCliApp
See theHttpCliApp companion class
object HttpCliApp

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
HttpCliApp.type

Members list

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def fromEndpoints(name: String, version: String, summary: Span, endpoints: Chunk[Endpoint[_, _, _, _, _]], host: String, port: Int, footer: HelpDoc, config: CliConfig, figFont: FigFont, cliStyle: Boolean, client: CliClient): HttpCliApp[Any, Throwable, CliRequest]

Generates a HttpCliApp from the given endpoints.

Generates a HttpCliApp from the given endpoints.

Value parameters

cliStyle

Style of commands of the generated CLI: true for CLI idiomatic interface, false for HTTP-like interface

config

Configuration of the generated CLI

endpoints

Chunk of Endpoint

figFont

FigFont to use for man pages of the generated CLI

footer

Footer for the help docs of the generated CLI

host

The server host where the generated CLI will send requests to

name

The name of the generated CLI

port

The server port where the generated CLI will send requests to

summary

The summary of the generated CLI

version

The version of the generated CLI

Attributes

Returns

a HttpCliApp

Generated with