Publish pkldoc as a standalone CLI #102

Closed
opened 2025-12-30 01:20:48 +01:00 by adam · 4 comments
Owner

Originally created by @StefMa on GitHub (Mar 3, 2024).

Seems like an known issue but not tracked as an issue yet 🙃

Originally created by @StefMa on GitHub (Mar 3, 2024). Seems like an [known issue](https://pkl-lang.org/main/current/pkl-doc/index.html#install-cli) but not tracked as an issue yet 🙃
adam closed this issue 2025-12-30 01:20:48 +01:00
Author
Owner

@odenix commented on GitHub (Mar 5, 2024):

The same problem exists for Java and Kotlin code generation. Gradle users can use the Gradle plugin.

@odenix commented on GitHub (Mar 5, 2024): The same problem exists for Java and Kotlin code generation. Gradle users can use the Gradle plugin.
Author
Owner

@StefMa commented on GitHub (Mar 20, 2024):

If I see it correctly, a module for doc gen already exist. The pkl-doc module.

I thought we can simply use this in the pkl-cli module 🤔 can we?

While checking this, I stumbled over the differences how the Gradle plugin declares dependencies compared to how the cli declare dependencies.

While the Gradle plugin uses the pkl-tools fatJar, the cli declares all its dependencies "normally".

I don't know what the rationale behind this is, but I ask myself if the cli should also declare a dependency like the Gradle plugin or vice versa or... Keep everything like it is?
Maybe someone can explain this?! 🙃

nvmd. The cli can't depend on tools as tools depends on cli...

@StefMa commented on GitHub (Mar 20, 2024): If I see it correctly, a module for doc gen already exist. The pkl-doc module. I thought we can simply use this in the pkl-cli module 🤔 can we? While checking this, I stumbled over the differences how the Gradle plugin declares dependencies compared to how the cli declare dependencies. While the Gradle plugin uses the pkl-tools fatJar, the cli declares all its dependencies "normally". ~I don't know what the rationale behind this is, but I ask myself if the cli should also declare a dependency like the Gradle plugin or vice versa or... Keep everything like it is? Maybe someone can explain this?! 🙃~ nvmd. The cli can't depend on tools as tools depends on cli...
Author
Owner

@bioball commented on GitHub (Mar 20, 2024):

If we support this, we'd probably publish these as standalone tools. For now, you can use pkl-tools as the "standalone CLI" (see comment here: https://github.com/apple/pkl/discussions/272#discussioncomment-8636479).

@bioball commented on GitHub (Mar 20, 2024): If we support this, we'd probably publish these as standalone tools. For now, you can use `pkl-tools` as the "standalone CLI" (see comment here: https://github.com/apple/pkl/discussions/272#discussioncomment-8636479).
Author
Owner

@odenix commented on GitHub (Mar 20, 2024):

I think the goal should be for tools to communicate with Pkl over the binary protocol. Then each tool can have its own, small native executable.

@odenix commented on GitHub (Mar 20, 2024): I think the goal should be for tools to communicate with Pkl over the binary protocol. Then each tool can have its own, small native executable.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/pkl#102