quarkdown-cli/com.quarkdown.cli.exec

Package-level declarations

Types

CompileCommand

class CompileCommand : ExecuteCommand

Command to compile a Quarkdown file into an output.

ExecuteCommand

abstract class ExecuteCommand(name: String) : CliktCommand

Template for Quarkdown commands that launch a complete pipeline and produce output files.

ExecutionOutcome

data class ExecutionOutcome(val resource: OutputResource?, val directory: File?, val pipeline: Pipeline)

Outcome of a pipeline execution.

ReplCommand

class ReplCommand : ExecuteCommand

Command to start Quarkdown in interactive REPL mode.

Properties

DEFAULT_LIBRARY_DIRECTORY

val DEFAULT_LIBRARY_DIRECTORY: String

Name of the default directory to load libraries from. The default value is relative to the executable JAR file location, and points to the lib/qmd directory of the distribution archive. It can be overridden by the user.

DEFAULT_OUTPUT_DIRECTORY

const val DEFAULT_OUTPUT_DIRECTORY: String

Name of the default directory to save output files in. It can be overridden by the user.

Functions

runQuarkdown

fun runQuarkdown(executionStrategy: PipelineExecutionStrategy, cliOptions: CliOptions, pipelineOptions: PipelineOptions): ExecutionOutcome

Executes a complete Quarkdown pipeline.

runServerCommunication

fun runServerCommunication(startServerOnFailedConnection: Boolean, options: WebServerOptions)

Communicates with the server to reload the requested resources. If the server is not running, starts it if startServerOnFailedConnection is true and tries to communicate again.