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 (4)

Authors

  1. T
    The topkg programmers

Maintainers

  1. Daniel Bünzli

Sources

topkg-1.1.1.tbz
sha512=c36c549a362ddf5b7fe3f6ff91c79b7ab531c43633bb9737576370bcbd69db7e1625d247c278a869b503d45a175e9753231ccf595e5bfa4e3b7e2602ac3d3b42

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: 05 Nov 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"
  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. octavius < "1.1.0"
  57. odds < "1.1"
  58. odig
  59. oml
  60. omod
  61. opaca
  62. osx-cf
  63. otfm
  64. papi < "0.1.1"
  65. pkcs11 < "0.18.0"
  66. ppx_compose < "0.0.4"
  67. psq < "0.1.1"
  68. ptime
  69. py < "1.1"
  70. qrc
  71. react
  72. records >= "0.7.0" & < "1.0.0"
  73. rfc6287 < "1.0.4"
  74. rresult
  75. salsa20 < "1.0.0"
  76. salsa20-core < "1.0.0"
  77. sattools
  78. scid
  79. sendmsg
  80. shcaml
  81. simple-diff >= "0.2.1"
  82. sturgeon < "0.4.2"
  83. syslog-message = "0.0.2"
  84. systemverilog < "0.0.2"
  85. terminal_size < "0.1.4"
  86. tgls >= "0.9.1"
  87. tls < "0.12.8"
  88. topkg-care >= "1.1.1"
  89. topkg-jbuilder
  90. tsdl
  91. ttweetnacl
  92. unix-type-representations >= "0.1.1" & < "0.1.3"
  93. uucd
  94. uucp
  95. uuidm
  96. uunf
  97. uuseg
  98. uutf
  99. vg
  100. wamp < "1.2"
  101. webbrowser
  102. xmlm
  103. yurt < "0.6"
  104. zipc
  105. zlist < "0.4.0"
  106. zxcvbn < "2.3+2"

Conflicts

None