Skip to content

Commit

Permalink
add similar to docs
Browse files Browse the repository at this point in the history
Signed-off-by: vsoch <[email protected]>
  • Loading branch information
vsoch committed Jun 16, 2024
1 parent 0aa5836 commit 49fe0d3
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
6 changes: 0 additions & 6 deletions container_guts/client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,6 @@ def get_parser():
description="take a diff of your container against a guts database.",
formatter_class=argparse.RawTextHelpFormatter,
)
diff.add_argument(
"--db",
"--database",
help="Database root (of json files) to use, either filesystem or git URL to clone",
dest="database",
)
similar = subparsers.add_parser(
"similar",
description="calculate similarity of your container against a guts database.",
Expand Down
17 changes: 14 additions & 3 deletions docs/getting_started/user-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,24 @@ Or to get fs and paths:
This generic "manifest" command is the main entrypoint to extract guts.

-------
Similar
-------

This command calculates a similarity comparison between your container and the database
of base images we maintain with shpc. We do this based on filesystem paths. We first remove
all paths that are unique to your image, and then with what is left, we calculate the intersection
over the total filesystem paths left in your image, which is saying "The percentage of non-unique
paths that are shared between your image and the contender base."

.. code-block:: console
$ guts similar vanessa/salad
----
Diff
----

**under development**

A diff will take your container and compares it against a set of base images,
and only reveals the diff output (the executables in PATH that are special
to your container). If you don't provide a database (repository or path
Expand All @@ -63,7 +75,6 @@ on the filesystem) we use the default at ``singularityhub/shpc-guts``.
$ guts diff vanessa/salad
Note that this command is not officially added yet!
GitHub Action
-------------
Expand Down

0 comments on commit 49fe0d3

Please sign in to comment.