bbin instructions missing

[martinklepsch]

Hey there!

I installed via bbin and couldn't quite figure out how to make use of this from a CLI args perspective (probably bbin does allow me to call ns functions?) but then also ran into an exception running it

~/c/b/o/xxx (main|⚡3) quickdoc --source-paths "src/cljc/xx/xx/common/utils.cljc"
----- Error --------------------------------------------------------------------
Type:     java.io.FileNotFoundException
Message:  Could not locate borkdude/quickdoc.bb, borkdude/quickdoc.clj or borkdude/quickdoc.cljc on classpath.
Location: <expr>:1:10

----- Context ------------------------------------------------------------------
1: (ns user (:require [borkdude.quickdoc])) (apply borkdude.quickdoc/-main *command-line-args*)
            ^--- Could not locate borkdude/quickdoc.bb, borkdude/quickdoc.clj or borkdude/quickdoc.cljc on classpath. 

bbin -v
Version: 0.2.4

bbin ls
bin       version  location
────────  ───────  ────────────────────────────────────────
quickdoc  v0.2.3   https://github.com/borkdude/quickdoc.git

So there's two issues here:

1. The exception above
2. CLI usage unclear (maybe @eval can help?)

Cheers 🙏

[borkdude]

Could be a bug in bbin? If you do cat $(which quickdoc) you should be able to debug the script...

[borkdude]

Ah, the namepace structure isn't borkdude.quickdoc but quickdoc.api

[borkdude]

I wonder where bbin gets this from... Any ideas @rads ?

[borkdude]

@martinklepsch This seems to work:

bbin install io.github.borkdude/quickdoc --tool --ns-default quickdoc.api

and then:

quickdoc quickdoc --paths src

Perhaps this needs to be removed from the documentation though since it seems a bit cumbersome to use it like this.