{"id":315,"date":"2025-06-18T21:26:42","date_gmt":"2025-06-18T21:26:42","guid":{"rendered":"https:\/\/cptdcli.com\/?p=315"},"modified":"2025-06-19T22:38:26","modified_gmt":"2025-06-19T22:38:26","slug":"add-new-command-cpdsl","status":"publish","type":"post","link":"https:\/\/www.cptdcli.org\/?p=315","title":{"rendered":"Added NEW command : CPDSL"},"content":{"rendered":"\n
\n
\n
<\/div>\n\n\n\n
\n

\ud83d\udcdc Description of the cpdsl Command (cptd >= v2.0.5)<\/h2>\n\n\n\n

Name:<\/strong> cpdsl<\/strong>
Role:<\/strong> Interpreter for declarative .dsl<\/strong> scripts enabling sequential execution of installed cptd<\/code> commands
Platform Support:<\/strong> Cross-platform (Linux \/ Windows \/ macOS)
Format:<\/strong> Step-based YAML scenario files<\/p>\n\n\n\n

\n\n\n\n

\ud83d\ude80 What Is cpdsl<\/code> and Why Does It Matter?<\/h2>\n\n\n\n

cpdsl <\/strong>is the official scenario interpreter within the CPTD CLI<\/strong> platform. It reads YAML-based workflows line by line, step by step \u2014 transforming manual command sequences into structured, repeatable, and secure automation pipelines.<\/p>\n\n\n\n

\n\n\n\n

\ud83e\udde0 Why Use cpdsl?<\/h3>\n\n\n\n
    \n
  • Automate routine procedures using registered cptd<\/code> commands<\/li>\n\n\n\n
  • Replace unreliable shell scripts with validated YAML instructions<\/li>\n\n\n\n
  • Ensure portability \u2014 a single .dsl file can run anywhere<\/li>\n\n\n\n
  • Achieve full transparency, reproducibility, and structured logging<\/li>\n\n\n\n
  • Centralize complex operations such as backups, encryption, uploads, logging, and more<\/li>\n<\/ul>\n\n\n\n
    \n\n\n\n

    \ud83d\udccc Why It\u2019s Convenient<\/h2>\n\n\n\n
      \n
    • A single .dsl <\/strong>file encapsulates an entire workflow<\/li>\n\n\n\n
    • Easily share automation logic as modules or assets<\/li>\n\n\n\n
    • Seamless GUI integration (e.g., a “Run Backup” button)<\/li>\n\n\n\n
    • Easy debugging and reusability of automation logic<\/li>\n<\/ul>\n\n\n\n
      \n\n\n\n

      \ud83d\udcca Advantages of the DSL Approach<\/h2>\n\n\n\n
      Feature<\/th>Advantage<\/th><\/tr><\/thead>
      \ud83d\udce6 Uniformity<\/td>All commands are launched through a consistent interface<\/td><\/tr>
      \u267b\ufe0f Reusability<\/td>One DSL file can run on thousands of machines or via scheduled tasks<\/td><\/tr>
      \ud83d\udccb Self-documenting<\/td>DSL reads like a technical spec or execution plan<\/td><\/tr>
      \ud83e\uddf1 Extensibility<\/td>Future-ready: if<\/code>, loop<\/code>, include<\/code>, when<\/code> and more are possible<\/td><\/tr>
      \ud83d\udd10 Security<\/td>Immune to shell injection, eval<\/code>, or accidental rm -rf<\/code> disasters<\/td><\/tr>
      \ud83e\udde0 Cross-platform<\/td>Same .dsl<\/code> works on Windows, Linux, and remote servers<\/td><\/tr>
      \ud83e\uddf0 Integratable<\/td>Can be invoked from UI buttons, web dashboards, apps, or triggers<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      \n\n\n\n

      \ud83d\udcc2 Example Command<\/h2>\n\n\n\n
      cptd cpdsl run backup.dsl --log out.txt --strict --wait-all --summary\n<\/code><\/pre>\n\n\n\n
      \n\n\n\n
      \ud83c\udfc1 Conclusion<\/h2>\n\n\n\n
      cpdsl isn\u2019t just syntax \u2014 it\u2019s structure. It\u2019s automation strategy with clarity and control.<\/p>\n\n\n\n
      Forget chaotic bash chains and cryptic &&<\/code> sequences.
      Write readable, testable, extensible workflows that evolve with your project.<\/p>\n\n\n\n
      cpdsl \u2014 Structure your CLI. Define your workflows. Automate with precision.<\/strong><\/p>\n\n\n\n
      \n\n\n\n
      \ud83d\udcd8 YAML Scenario Guide for cpdsl<\/code><\/h1>\n\n\n\n
      cpdsl is a YAML-based scenario interpreter for sequential and parallel command execution within the CPTD CLI<\/strong> system.
      Scenarios let you combine complex processes (archiving, encryption, uploading, testing, etc.) into a single descriptive file.<\/p>\n\n\n\n
      \n\n\n\n
      \ud83e\uddf1 Basic File Structure (.dsl)<\/h2>\n\n\n\n
      name: \"Scenario Name\"\ndescription: \"Short description of purpose\"\n\nsteps:\n  - name: \"Step Name\"\n    command: \"command_name\"\n    args:\n      --flag1: value\n      --flag2: true\n    async: true\n    depends_on: \"step_name\"\n<\/code><\/pre>\n\n\n\n
      \n\n\n\n
      \ud83e\udde9 Field Descriptions<\/h2>\n\n\n\n
      \ud83d\udd39 Top-Level Fields:<\/h3>\n\n\n\n
      Field<\/th>Type<\/th>Purpose<\/th><\/tr><\/thead>
      name<\/code><\/td>string<\/td>Human-readable scenario name<\/td><\/tr>
      description<\/code><\/td>string<\/td>Short summary<\/td><\/tr>
      steps<\/code><\/td>list<\/td>Array of step definitions (see below)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      \n\n\n\n
      \ud83d\udd39 Inside steps[]<\/code>:<\/h3>\n\n\n\n
      Field<\/th>Type<\/th>Required<\/th>Purpose<\/th><\/tr><\/thead>
      name<\/code><\/td>string<\/td>No<\/td>Step name (for display and depends_on<\/code>)<\/td><\/tr>
      command<\/code><\/td>string<\/td>\u2705 Yes<\/td>Name of the registered CPTD command<\/td><\/tr>
      args<\/code><\/td>dict --flag: val<\/code><\/td>No<\/td>Arguments for the command. true<\/code> \u2192 flag only; false<\/code> \u2192 ignored<\/td><\/tr>
      async<\/code><\/td>bool<\/td>No<\/td>If true<\/code>, runs the step in the background<\/td><\/tr>
      depends_on<\/code><\/td>string \/ list<\/td>No<\/td>Dependencies. Runs only after specified step(s) complete<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      \n\n\n\n
      \ud83d\udd39 Special Feature: Environment Variables<\/h3>\n\n\n\n
      Instead of a fixed value, you can reference an environment variable:<\/p>\n\n\n\n
      args:\n  --password-env: SFTP_PASS\n<\/code><\/pre>\n\n\n\n
      Inside cpdsl, this becomes:<\/p>\n\n\n\n
      --password-env <value of SFTP_PASS>\n<\/code><\/pre>\n\n\n\n
      \n\n\n\n
      \u2705 Example of a Simple Scenario<\/h2>\n\n\n\n
      name: \"Backup\"\ndescription: \"Mount, archive, and upload archive\"\n\nsteps:\n  - name: \"Mount\"\n    command: \"cpdisk\"\n    args:\n      --mount: true\n      --file: \"vault.hc\"\n\n  - name: \"Archive\"\n    command: \"compress\"\n    args:\n      --input: \"\/vault\/data\"\n      --output: \"\/tmp\/data.zip\"\n    depends_on: \"Mount\"\n\n  - name: \"Upload\"\n    command: \"uploader\"\n    args:\n      --file: \"\/tmp\/data.zip\"\n      --target: \"sftp:\/\/host\/upload\"\n      --password-env: SFTP_PASS\n    async: true\n    depends_on: \"Archive\"\n<\/code><\/pre>\n\n\n\n
      \n\n\n\n
      \ud83e\uddea Running a Scenario<\/h2>\n\n\n\n
      cptd cpdsl run backup.dsl --log log.txt --strict --wait-all --summary\n<\/code><\/pre>\n\n\n\n
      \ud83c\udf9b Run Arguments:<\/h3>\n\n\n\n
      Argument<\/th>Purpose<\/th><\/tr><\/thead>
      --log <file><\/code><\/td>Save execution log<\/td><\/tr>
      --strict<\/code><\/td>Stop on first error<\/td><\/tr>
      --wait-all<\/code><\/td>Wait for all async: true<\/code> steps to finish<\/td><\/tr>
      --summary<\/code><\/td>Print a summary table of step statuses at the end<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      \n\n\n\n
      \ud83d\udccb Example of Summary Output (--summary<\/code>)<\/h2>\n\n\n\n
      Summary:\n\u2714 Step 1 - Mount                [OK]\n\u2714 Step 2 - Archive              [OK]\n\u2714 Step 3 - Upload               [ASYNC]\n<\/code><\/pre>\n\n\n\n
      \n\n\n\n
      \u26a0\ufe0f Error Handling<\/h2>\n\n\n\n
      Scenario<\/th>Default Behavior<\/th>With --strict<\/code><\/th><\/tr><\/thead>
      depends_on<\/code> references unknown step<\/td>Error<\/td>Error<\/td><\/tr>
      Step exits with non-zero code<\/td>Continues<\/td>Stops<\/td><\/tr>
      Async step fails<\/td>Logs the error<\/td>Stops<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
      \n\n\n\n
      \ud83d\ude80 Writing Tips<\/h2>\n\n\n\n
        \n
      • Always assign a unique name: to each step<\/li>\n\n\n\n
      • Use depends_on to define logical order<\/li>\n\n\n\n
      • Use async: true for background tasks<\/li>\n\n\n\n
      • Store your .dsl files in scripts\/ or scenarios\/ for project structure<\/li>\n<\/ul>\n\n\n\n
         <\/p>\n<\/div>\n\n\n\n
        <\/div>\n<\/div>\n<\/div><\/div>\n\n\n\n
        <\/p>\n","protected":false},"excerpt":{"rendered":"
        \ud83d\udcdc Description of the cpdsl Command (cptd >= v2.0.5) Name: cpdslRole: Interpreter for declarative .dsl scripts enabling sequential execution of installed cptd commandsPlatform Support: Cross-platform (Linux \/ Windows \/ macOS)Format: Step-based YAML scenario files \ud83d\ude80 What Is cpdsl and Why Does It Matter? cpdsl is the official scenario interpreter within the CPTD CLI platform. It […]<\/p>\n","protected":false},"author":1,"featured_media":310,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[19],"tags":[],"class_list":["post-315","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-new-commands"],"_links":{"self":[{"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=\/wp\/v2\/posts\/315","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=315"}],"version-history":[{"count":8,"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=\/wp\/v2\/posts\/315\/revisions"}],"predecessor-version":[{"id":328,"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=\/wp\/v2\/posts\/315\/revisions\/328"}],"wp:attachment":[{"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=315"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=315"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.cptdcli.org\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=315"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}