share/man/nitc: Adding the man explication to disable contracts
[nit.git] / share / man / nitpm.md
1 # NAME
2
3 nitpm - Nit package manager
4
5 # SYNOPSIS
6
7 nitpm [--help] [--verbose] <command> [<args>]
8
9 # OPTIONS
10
11 ### `-h`, `--help`
12 Show help message.
13
14 ### `-v`, `--verbose`
15 Print more information.
16
17 # COMMANDS
18
19 ### `install`
20 Install packages by name, Git repository address or from the local package.ini.
21
22         # Search and install package by name, e.g. hello_nitpm:
23         nitpm install hello_nitpm
24
25         # Install package from a Git repository:
26         nitpm install https://gitlab.com/xymus/hello_nitpm.git
27
28         # Search and install a specific branch or tag of a package, e.g. 1.0:
29         nitpm install nitpm_test_versions=1.0
30
31         # Install all packages declared in the local package.ini file:
32         nitpm install
33
34 To support the last command, the package.ini file should list the required packages after `[package]` on an `import=` line:
35
36         [package]
37         name=my_package
38         import=nitpm_test_versions=1.0,gamnit
39
40 ### `list`
41 List installed packages.
42
43         nitpm list
44
45 ### `upgrade`
46 Upgrade a package.
47
48         nitpm upgrade hello_nitpm
49
50 ### `uninstall`
51 Uninstall packages.
52
53         nitpm uninstall hello_nitpm
54
55 ### `help`
56 Show general help message or the help for a command.
57
58         nitpm help
59         nitpm help install
60
61 # SEE ALSO
62
63 The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>