From e2b2df3aa6ae1d9203135aa89d8f2a0780bb80d3 Mon Sep 17 00:00:00 2001 From: Samuel Breton <35827261+samuel-breton@users.noreply.github.com> Date: Fri, 12 Sep 2025 00:07:35 -0400 Subject: [PATCH] pkl: add page (#18024) * Add Pkl CLI documentation New TLDR proposed page for the Pkl CLI, an embedded configuration language with rich support for validation and tooling. * Apply suggestion from @TheRootDaemon Co-authored-by: Harshavardhan * Improve clarity in Pkl CLI documentation Updated markdown formatting for Pkl command line interface documentation. * Revise Pkl documentation for clarity * Update pages/common/pkl.md Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> * Update pages/common/pkl.md Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> --------- Co-authored-by: Harshavardhan Co-authored-by: Managor <42655600+Managor@users.noreply.github.com> --- pages/common/pkl.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 pages/common/pkl.md diff --git a/pages/common/pkl.md b/pages/common/pkl.md new file mode 100644 index 0000000000..bbcad71f41 --- /dev/null +++ b/pages/common/pkl.md @@ -0,0 +1,28 @@ +# pkl + +> Manages, evaluates, and tests Pkl configuration modules. +> More information: . + +- Evaluate the given Pkl modules and produce their rendering results: + +`pkl eval {{module.pkl}}` + +- Run as a server that communicates over standard input/output: + +`pkl server` + +- Evaluate Pkl modules as tests and produces a report: + +`pkl test {{module.pkl}}` + +- Start a REPL session: + +`pkl repl` + +- Prepare a Pkl project for publishing as a package: + +`pkl project package {{path/to/project_directory}}` + +- Resolve project dependencies and writes the resolved versions to a file at path `PklProject.deps.json`: + +`pkl project resolve {{path/to/project_directory}}`