Public API for kit-generator.
Public API for kit-generator.
(find-snippet-ids query)(find-snippets query)(install-module module-key)(install-module module-key opts)(install-module module-key kit-edn-path {:keys [accept-hooks? dry?] :as opts})Installs a kit module into the current project or the project specified by a path to kit.edn file.
NOTE: When adding new module-specific options, update flat-module-options. See the function for more details.
Installs a kit module into the current project or the project specified by a path to kit.edn file. > NOTE: When adding new module-specific options, update flat-module-options. See the function for more details.
(installation-plan module-key kit-edn-path opts)Loads and resolves modules in preparation for installation, as well as determining which modules are already installed vs which need to be installed.
Loads and resolves modules in preparation for installation, as well as determining which modules are already installed vs which need to be installed.
(list-installed-modules)Lists installed modules and modules that failed to install, for the current project.
Lists installed modules and modules that failed to install, for the current project.
(list-modules)List modules available for the current project.
List modules available for the current project.
(list-snippets)(print-installation-plan module-key)(print-installation-plan module-key opts)(print-installation-plan module-key kit-edn-path opts)Prints a detailed installation plan for a module and its dependencies.
Prints a detailed installation plan for a module and its dependencies.
(print-removal-report module-key)(print-removal-report module-key opts)(print-removal-report module-key kit-edn-path opts)Prints a human-readable removal report for an installed module.
Prints a human-readable removal report for an installed module.
(read-ctx)(read-ctx path)(removal-report module-key)(removal-report module-key opts)(removal-report module-key kit-edn-path opts)Generates a removal report for an installed module. Returns a map with:
Generates a removal report for an installed module. Returns a map with: - :module-key - :has-manifest? (whether detailed installation manifest is available) - :safe-to-remove (files that can be auto-deleted, SHA matches) - :modified-files (files modified since installation) - :missing-files (files deleted since installation) - :manual-steps (human-readable injection removal instructions) - :dependents (installed modules that depend on this one) Returns nil if the module is not installed.
(remove-module module-key)(remove-module module-key opts)(remove-module module-key kit-edn-path {:keys [force? dry?] :as opts})Removes a module from the project. Auto-deletes files that are unchanged since installation. Prints instructions for manual cleanup of injections.
Options: :force? - remove even if other modules depend on it :dry? - only print the removal report, don't delete anything
Removes a module from the project. Auto-deletes files that are unchanged since installation. Prints instructions for manual cleanup of injections. Options: :force? - remove even if other modules depend on it :dry? - only print the removal report, don't delete anything
(snippet id & args)(sync-modules)Downloads modules for the current project.
Downloads modules for the current project.
(sync-snippets)cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |