Skip to content

Commit 00c0e5e

Browse files
memshardedAbrilRBS
andauthored
new pkglist command (#3704)
* new pkglist command * Update reference/commands/pkglist.rst Co-authored-by: Rubén Rincón Blanco <[email protected]> --------- Co-authored-by: Rubén Rincón Blanco <[email protected]>
1 parent eb2b5cd commit 00c0e5e

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

reference/commands.rst

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ and these :ref:`custom command examples <examples_extensions_custom_commands>`
2323
commands/install
2424
commands/list
2525
commands/lock
26+
commands/pkglist
2627
commands/profile
2728
commands/remove
2829
commands/remote
@@ -36,6 +37,7 @@ and these :ref:`custom command examples <examples_extensions_custom_commands>`
3637
- :doc:`conan install <commands/install>`: Install dependencies
3738
- :doc:`conan list <commands/list>`: List recipes, revisions and packages in the local cache or in remotes
3839
- :doc:`conan lock <commands/lock>`: Create and manage lockfiles
40+
- :doc:`conan pkglist <commands/pkglist>`: Manipulate package lists, merge them or find packages in remotes.
3941
- :doc:`conan profile <commands/profile>`: Display and manage profile files
4042
- :doc:`conan remove <commands/remove>`: Remove packages from the local cache or from remotes
4143
- :doc:`conan remote <commands/remote>`: Add, remove, login/logout and manage remote server

reference/commands/pkglist.rst

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. _reference_commands_pkglist:
2+
3+
conan pkglist
4+
=============
5+
6+
.. include:: ../../common/experimental_warning.inc
7+
8+
9+
Perform different operations over package lists:
10+
11+
- Merge multiple package lists (deep merge) into a single one: ``conan pkglist merge``
12+
- Find in which remotes packages from the cache can be found: ``conan pkglist find-remote``
13+
14+
15+
conan pkglist merge
16+
--------------------
17+
18+
.. autocommand::
19+
:command: conan pkglist merge -h
20+
21+
The ``conan pkglist merge`` command can merge multiple package lists into a single one:
22+
23+
.. code-block:: bash
24+
25+
$ conan pkglist merge --list=list1.json --list=list2.json --format=json > result.json
26+
27+
28+
The merge will be a deep merge, different versions can be added, and within versions multiple
29+
revisions can be added, and for every recipe revision multiple package_ids can be also accumulated.
30+
31+
32+
conan pkglist find-remote
33+
-------------------------
34+
35+
.. autocommand::
36+
:command: conan pkglist find-remote -h
37+
38+
39+
The ``conan pkglist find-remote`` command will take a package list of packages in the cache
40+
(key ``"Local Cache"``) and look for them in the defined remotes. For every exact occurence in a remote
41+
matching the recipe, version, recipe-revision, etc, an entry in the resulting "package lists"
42+
will be added for that specific remote.

0 commit comments

Comments
 (0)