Skip to content

Commit

Permalink
Better explain environment variables
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel J Walsh <[email protected]>
  • Loading branch information
rhatdan committed Oct 15, 2024
1 parent 230b6c7 commit 169851a
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions ramalama/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,29 @@ def use_container():


def init_cli():
description="""\
On first run RamaLama inspects your system for GPU support, falling back to CPU
support if no GPUs are present. RamaLama uses container engines like Podman or
Docker to pull the appropriate OCI image with all of the software necessary to
run an AI Model for your systems setup. This eliminates the need for the user
to configure the system for AI themselves. After the initialization, RamaLama
will run the AI Models within a container based on the OCI image.\n
RamaLama first pulls AI Models from model registires. It then start a chatbot
or a service as a rest API from a simple single command. Models are treated
similarly to the way that Podman or Docker treat container images.
If you have both Podman and Docker installed, RamaLama defaults to Podman, use
the `RAMALAMA_CONTAINER_ENGINE=docker` environment variable to override this
behaviour.
RamaLama supports multiple AI model registries types called transports. Supported transports:
"""
parser = ArgumentParser(
prog="ramalama",
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
description="Simple management tool for working with AI Models.",
description = description,
)
parser.add_argument("--store", default=get_store(), help="store AI Models in the specified directory")
parser.add_argument(
Expand All @@ -84,7 +103,7 @@ def init_cli():
dest="container",
default=use_container(),
action="store_true",
help="run RamaLama in the default container",
help="run RamaLama in the default container. The RAMALAMA_IN_CONTAINER environment variable modifies default behaviour.",
)
parser.add_argument(
"--image",
Expand All @@ -96,7 +115,7 @@ def init_cli():
dest="container",
default=False,
action="store_false",
help="do not run RamaLama in the default container",
help="do not run RamaLama in the default container. The RAMALAMA_IN_CONTAINER environment variable modifies default behaviour.",
)
parser.add_argument(
"--runtime",
Expand Down

0 comments on commit 169851a

Please sign in to comment.