package topkg

  1. Overview
  2. Docs
The transitory OCaml software packager

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (3)

Authors

  1. T
    The topkg programmers

Maintainers

  1. Daniel Bünzli

Sources

topkg-1.1.0.tbz
sha512=34d22ae5b6bd166dd4a601a7d12d89c336684b3c56d7c7f481b40837eab263616cc3a6e6f63602f3d4a7d53c911967bf261de6c1ac205341b98a9838e5ea7aeb

Description

Warning Topkg is in maintenance mode and should not longer be used.

Topkg is a packager for distributing OCaml software. It provides an API to describe the files a package installs in a given build configuration and to specify information about the package's distribution, creation and publication procedures.

The optional topkg-care package provides the topkg command line tool which helps with various aspects of a package's life cycle: creating and linting a distribution, releasing it on the WWW, publish its documentation, add it to the OCaml opam repository, etc.

Topkg is distributed under the ISC license and has no dependencies. This is what your packages will need as a build dependency.

Topkg-care is distributed under the ISC license it depends on fmt, logs, bos, cmdliner, webbrowser and opam-format.

Home page: http://erratique.ch/software/topkg

Tags

packaging ocamlbuild org:erratique

Published: 25 Jul 2025

README

Topkg — The transitory OCaml software packager

Warning Topkg is in maintenance mode and should not longer be used.

Topkg is a packager for distributing OCaml software. It provides an API to describe the files a package installs in a given build configuration and to specify information about the package's distribution, creation and publication procedures.

The optional topkg-care package provides the topkg command line tool which helps with various aspects of a package's life cycle: creating and linting a distribution, releasing it on the WWW, publish its documentation, add it to the OCaml opam repository, etc.

Topkg is distributed under the ISC license and has no dependencies. This is what your packages will need as a build dependency.

Topkg-care is distributed under the ISC license it depends on fmt, logs, bos, cmdliner, webbrowser and opam-format.

Home page: http://erratique.ch/software/topkg

Installation

Topkg and topkg-care can be installed with opam:

    opam install topkg       # All you need for your packages
opam install topkg-care  # topkg binary, takes care of your packages

If you don't use opam consult the topkg.opam and topkg-care.opam files for build instructions.

Documentation

A basic introduction and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online.

The topkg command line tool is extensively documented in man pages available through it's help system. Type:

topkg help release # for help about releasing your package
topkg help         # for more help

Dependencies (3)

  1. ocamlbuild
  2. ocamlfind build & >= "1.6.1"
  3. ocaml >= "4.08.0"

Dev Dependencies

None

  1. afl-persistent < "1.2"
  2. anycache < "0.7.4"
  3. asetmap
  4. asn1-combinators < "0.2.5"
  5. astring
  6. b0
  7. base64 = "2.1.2"
  8. bos
  9. bpf
  10. brr
  11. bytesrw
  12. certify < "0.3.0"
  13. cmarkit
  14. cmdtui < "0.4.3"
  15. conex < "0.10.0"
  16. cow = "2.2.0"
  17. cpuid < "0.1.2"
  18. digestif < "0.6.1"
  19. down
  20. enumerators >= "0.2.0"
  21. ezsqlite < "0.4"
  22. farfadet
  23. fmt
  24. fpath
  25. gg
  26. higher >= "0.3.1"
  27. hiredis < "0.8"
  28. hmap
  29. htmlit
  30. integers < "0.3.0"
  31. inuit < "0.4.1"
  32. jekyll-format < "0.2.0"
  33. jsonm
  34. jsont
  35. key-parsers < "0.10.1"
  36. libudev
  37. linkage
  38. logs
  39. lru < "0.3.0"
  40. mergeable-vector
  41. minima-theme
  42. mirage-channel < "3.1.0"
  43. mirage-kv < "1.1.1"
  44. mirage-kv-lwt < "1.1.0"
  45. mirage-net-macosx >= "1.2.0" & < "1.4.0"
  46. msgpck < "1.3"
  47. mtime
  48. named-pipe >= "0.4.0"
  49. nlp
  50. nocrypto
  51. nosetup
  52. note
  53. notty < "0.2.3"
  54. obandit
  55. ocb-stubblr >= "0.1.0"
  56. ocp-index-top
  57. octavius < "1.1.0"
  58. odds < "1.1"
  59. odig
  60. oml >= "0.0.7"
  61. omod
  62. opaca
  63. osx-cf
  64. otfm
  65. papi < "0.1.1"
  66. pkcs11 < "0.18.0"
  67. ppx_compose < "0.0.4"
  68. psq < "0.1.1"
  69. ptime
  70. py < "1.1"
  71. qrc
  72. react
  73. records >= "0.7.0" & < "1.0.0"
  74. rfc6287 < "1.0.4"
  75. rresult
  76. salsa20 < "1.0.0"
  77. salsa20-core < "1.0.0"
  78. sattools
  79. scid
  80. sendmsg
  81. shcaml
  82. simple-diff >= "0.2.1"
  83. statmemprof-emacs
  84. sturgeon < "0.4.2"
  85. syslog-message = "0.0.2"
  86. systemverilog < "0.0.2"
  87. terminal_size < "0.1.4"
  88. tgls >= "0.9.1"
  89. tls < "0.12.8"
  90. topkg-care >= "1.1.0"
  91. topkg-jbuilder
  92. tsdl
  93. ttweetnacl
  94. unix-type-representations >= "0.1.1"
  95. uucd
  96. uucp
  97. uuidm
  98. uunf
  99. uuseg
  100. uutf
  101. vg
  102. wamp < "1.2"
  103. webbrowser
  104. xmlm
  105. yurt < "0.6"
  106. zipc
  107. zlist < "0.4.0"
  108. zxcvbn < "2.3+2"

Conflicts

None