OPAM is a source-based package manager for OCaml. It supports multiple simultaneous compiler installations, flexible package constraints, and a Git-friendly development workflow.
OCaml Makefile Shell M4 Python
Pull request Compare This branch is 6 commits ahead, 167 commits behind ocaml:master.
Latest commit 6ead02d May 2, 2016 @AltGr AltGr wip testing
Failed to load latest commit information.
admin-scripts Fix admin-scripts Makefile to not depend on installed opam-lib Apr 12, 2016
doc Discard OCaml pre-4.01.0 source compatibility Apr 15, 2016
m4 remove caml4boot from the test, as its not used and sometimes (on Deb… Feb 4, 2013
shell Merge pull request #2456 from inhabitedtype/master Apr 9, 2016
src wip testing May 13, 2016
src_ext Fix 'pin add --dev' with missing name or version Apr 15, 2016
tests Fix 'opam list' for installed, unavailable packages May 2, 2016
.gitignore Provide opam files for installing sub-libs as separate packages Apr 25, 2016
.merlin Fix .merlin Mar 24, 2016
.ocp-indent Make --dry-run a real dry-run, and add --show to check the update Feb 12, 2014
.travis-ci.sh Travis: update lwt, cohttp dependencies to support 4.03 May 12, 2016
.travis.yml Travis: allow failure on OSX opam-rt for now May 13, 2016
AUTHORS Add note on OpamVersionCompare (from dose) copyright Apr 10, 2015
CHANGES Discard OCaml pre-4.01.0 source compatibility Apr 15, 2016
CONTRIBUTING.md update CONTRIBUTING to ask for `opam config report` Jan 13, 2014
LICENSE A few copyright and license fixes Sep 23, 2013
META.in Clean up declared library dependencies and META Aug 19, 2015
Makefile Restore the old 'make libinstall' for now May 2, 2016
Makefile.config.in Provide opam files for installing sub-libs as separate packages Apr 25, 2016
OCamlMakefile Makefile: fix dependencies calculation Jun 23, 2014
README.md Discard OCaml pre-4.01.0 source compatibility Apr 15, 2016
appveyor.yml Fix Appveyor Cygwin mirror May 16, 2015
configure Provide opam files for installing sub-libs as separate packages Apr 25, 2016
configure.ac Provide opam files for installing sub-libs as separate packages Apr 25, 2016
opam-client.opam Provide opam files for installing sub-libs as separate packages Apr 25, 2016
opam-core.opam Provide opam files for installing sub-libs as separate packages Apr 25, 2016
opam-devel.opam Discard OCaml pre-4.01.0 source compatibility Apr 15, 2016
opam-format.opam Provide opam files for installing sub-libs as separate packages Apr 25, 2016
opam-repository.opam Provide opam files for installing sub-libs as separate packages Apr 25, 2016
opam-solver.opam Provide opam files for installing sub-libs as separate packages Apr 25, 2016
opam-state.opam Provide opam files for installing sub-libs as separate packages Apr 25, 2016
opam.install Don't install manpages for command aliases Jun 18, 2014

README.md

OPAM - A package manager for OCaml

OPAM is a source-based package manager for OCaml. It supports multiple simultaneous compiler installations, flexible package constraints, and a Git-friendly development workflow.

OPAM was created and is maintained by OCamlPro.

To get started, checkout the Install and Usage guides.

Compiling this repo

  • Make sure you have OCaml and GNU make installed. If you don't have a recent enough version of OCaml (>= 4.01.0) at hand, see the next section.
  • Run ./configure
  • Run make lib-ext as advertised by ./configure if you don't have the dependencies installed. This will locally take care of all OCaml dependencies for you (downloading them, unless you used the inclusive archive we provide for each release).
  • Run make
  • Run make install

This is all you need for installing and using opam, but if you want to use the opam-lib (to work on opam-related tools), you need to link it to installed libraries, rather than use make lib-ext which would cause conflicts. It's easier to already have a working opam installation in this case, so you can do it as a second step.

  • Make sure to have ocamlfind, ocamlgraph, cmdliner, jsonm, cudf, dose 3.2.2+opam and re >= 1.2.0 installed. Or run opam install opam-lib --deps-only if you already have a working instance. Re-run ./configure once done
  • Run make libinstall at the end

Compiling without OCaml

make cold is provided as a facility to compile OCaml, then bootstrap OPAM. You don't need need to run ./configure in that case, but you may specify CONFIGURE_ARGS if needed, e.g.:

make cold CONFIGURE_ARGS="--prefix ~/local"

NOTE: You'll still need GNU make.

Bug tracker

Have a bug or a feature request ? Please open an issue on our bug-tracker. Please search for existing issues before posting, and include the output of opam config report and any details that may help track down the issue.

Documentation

User Manual

The main documentation entry point to OPAM is the user manual, available using opam --help. To get help for a specific command, use opam <command> --help.

Guides and Tutorials

A collection of guides and tutorials is available online. They are generated from the files in doc/pages.

API, Code Documentation and Developer Manual

A more thorough technical document describing OPAM and specifying the package description format is available in the developer manual. make doc will otherwise make the API documentation available under doc/.

Community

Keep track of development and community news.

  • Have a question that's not a feature request or bug report? Ask on the mailing list.

  • Chat with fellow OPAMers on IRC. On the irc.freenode.net server, in the #ocaml or the #opam channel.

Contributing

We welcome contributions ! Please use Github's pull-request mechanism against the master branch of the OPAM repository. If that's not an option for you, you can use git format-patch and email TODO.

Versioning

The release cycle respects Semantic Versioning.

Related repositories

  • ocaml/opam-repository is the official repository for OPAM packages and compilers. A number of non-official repositories are also available on the interwebs, for instance on Github.
  • opam2web generates a collection of browsable HTML files for a given repository. It is used to generate http://opam.ocaml.org.
  • opam-rt is the regression framework for OPAM.
  • opam-publish is a tool to facilitate the creation, update and publication of OPAM packages.

Copyright and license

The version comparison function in src/core/opamVersionCompare.ml is part of the Dose library and Copyright 2011 Ralf Treinen.

All other code is:

Copyright 2012-2015 OCamlPro Copyright 2012 INRIA

All rights reserved. OPAM is distributed under the terms of the GNU Lesser General Public License version 3.0.

OPAM is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.