quarkdown-cli/com.quarkdown.cli.exec

Package-level declarations

Types

Link copied to clipboard
class CompileCommand : ExecuteCommand

Command to compile a Quarkdown file into an output.

Link copied to clipboard
abstract class ExecuteCommand(name: String) : CliktCommand

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

Link copied to clipboard
data class ExecutionOutcome(val resource: OutputResource?, val directory: File?, val pipeline: Pipeline)

Outcome of a pipeline execution.

Link copied to clipboard
class ExecutionTimeoutException(val timeoutSeconds: Int) : RuntimeException

Thrown when the execution exceeds the allowed timeoutSeconds.

Link copied to clipboard
class ReplCommand : ExecuteCommand

Command to start Quarkdown in interactive REPL mode.

Properties

Link copied to clipboard
const val DEFAULT_OUTPUT_DIRECTORY: String

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

Functions

Link copied to clipboard
fun runQuarkdown(executionStrategy: PipelineExecutionStrategy, cliOptions: CliOptions, pipelineOptions: PipelineOptions): ExecutionOutcome

Executes a complete Quarkdown pipeline.

Link copied to clipboard
fun runServerCommunication(options: WebServerOptions, session: ServerMessageSession)

Communicates with the server to reload the requested resources. If the session is not active, starts the server.