🚸 Various changes to improve usability.

Fixed only partial information when using , added more sub-commands to .

Author: kzscisoft

CHANGELOG.md

@@ -1,11 +1,20 @@
+# Unreleased
+
+- Various fixes to columns in `list` sub-commands, this includes fixing `N/A` where data could not be found.
+- Added `pull` command to `run` for retrieving artifacts.
+- `--plain` mode now displays all data as expected, with formatting disabled.
+- Added additional sub-commands for `Tag` type.
+
 # [v1.0.1](https://github.com/simvue-io/simvue-cli/releases/tag/v1.0.1) - 2025-03-31
-* Fixed typing bug for Generator.
+
+- Fixed typing bug for Generator.
 
 # [v1.0.0](https://github.com/simvue-io/simvue-cli/releases/tag/v1.0.0) - 2025-03-31
-* Added list commands for viewing objects including runs, folders, tags etc.
-* Added user and tenant creation.
-* Added virtual environment initialisation from runs.
-* Added JSON dumping of objects.
-* Added command for checking server availability.
-* Added ability to attach metrics to an existing run.
-* Added creation of new runs from CLI.
+
+- Added list commands for viewing objects including runs, folders, tags etc.
+- Added user and tenant creation.
+- Added virtual environment initialisation from runs.
+- Added JSON dumping of objects.
+- Added command for checking server availability.
+- Added ability to attach metrics to an existing run.
+- Added creation of new runs from CLI.

src/simvue_cli/actions.py

@@ -405,6 +405,20 @@ def create_simvue_s3_storage(
     return _storage
 
 
+def create_simvue_tag(
+    name: str,
+    color: str | None,
+    description: str | None,
+) -> Tag:
+    _tag = Tag.new(name=name)
+    if color:
+        _tag.colour = color
+    if description:
+        _tag.description = description
+    _tag.commit()
+    return _tag
+
+
 def create_user_alert(
     name: str, trigger_abort: bool, email_notify: bool, description: str | None
 ) -> Alert:
@@ -585,6 +599,11 @@ def get_user(user_id: str) -> User:
     return User(identifier=user_id)
 
 
+def get_artifact(artifact_id: str) -> Tag:
+    """Retrieve an artifact from the server"""
+    return Artifact(identifier=artifact_id)
+
+
 def delete_tenant(tenant_id: str) -> None:
     """Delete a given tenant from the Simvue server"""
     _tenant = get_tenant(tenant_id)

src/simvue_cli/cli/__init__.py

@@ -25,7 +25,7 @@
 import tabulate
 import requests
 import simvue as simvue_client
-from simvue.api.objects import Alert, Run, Folder, S3Storage, Tag, Storage
+from simvue.api.objects import Alert, Run, Folder, S3Storage, Tag, Storage, Artifact
 from simvue.api.objects.administrator import User, Tenant
 from simvue.exception import ObjectNotFoundError
 
@@ -910,10 +910,27 @@ def get_folder_json(folder_id: str) -> None:
 @simvue.group("tag")
 @click.pass_context
 def simvue_tag(ctx) -> None:
-    """Create or retrieve Simvue runs"""
+    """Create or retrieve Simvue tags"""
     pass
 
 
+@simvue_tag.command("create")
+@click.pass_context
+@click.argument("name", type=SimvueName)
+@click.option(
+    "--color",
+    type=str,
+    default=None,
+    help="Color for this tag, e.g. '#fffff', 'blue', 'rgb(23, 54, 34)'",
+)
+@click.option("--description", type=str, default=None, help="Description for this tag.")
+def create_tag(ctx, **kwargs) -> None:
+    """Create a tag"""
+    result = simvue_cli.actions.create_simvue_tag(**kwargs)
+    alert_id = result.id
+    click.echo(alert_id if ctx.obj["plain"] else click.style(alert_id))
+
+
 @simvue_tag.command("list")
 @click.pass_context
 @click.option(
@@ -961,6 +978,7 @@ def tag_list(
     color: bool,
     **kwargs,
 ) -> None:
+    """Retrieve tags list from Simvue server."""
     tags = simvue_cli.actions.get_tag_list(**kwargs)
     if not tags:
         return
@@ -1007,6 +1025,60 @@ def get_tag_json(tag_id: str) -> None:
         click.echo(error_msg, fg="red", bold=True)
 
 
+@simvue_tag.command("remove")
+@click.pass_context
+@click.argument("tag_ids", type=str, nargs=-1, required=False)
+@click.option(
+    "-i",
+    "--interactive",
+    help="Prompt for confirmation on removal",
+    type=bool,
+    default=False,
+    is_flag=True,
+)
+def delete_tag(ctx, tag_ids: list[str] | None, interactive: bool) -> None:
+    """Remove a tag from the Simvue server"""
+    if not tag_ids:
+        tag_ids = []
+        for line in sys.stdin:
+            if not line.strip():
+                continue
+            tag_ids += [k.strip() for k in line.split(" ")]
+
+    for tag_id in tag_ids:
+        try:
+            simvue_cli.actions.get_tag(tag_id)
+        except (ObjectNotFoundError, RuntimeError):
+            error_msg = f"Tag '{tag_id}' not found"
+            if ctx.obj["plain"]:
+                print(error_msg)
+            else:
+                click.secho(error_msg, fg="red", bold=True)
+            sys.exit(1)
+
+        if interactive:
+            remove = click.confirm(f"Remove tag '{tag_id}'?")
+            if not remove:
+                continue
+
+        try:
+            simvue_cli.actions.delete_tag(tag_id)
+        except ValueError as e:
+            click.echo(
+                e.args[0]
+                if ctx.obj["plain"]
+                else click.style(e.args[0], fg="red", bold=True)
+            )
+            sys.exit(1)
+
+        response_message = f"Tag '{tag_id}' removed successfully."
+
+        if ctx.obj["plain"]:
+            print(response_message)
+        else:
+            click.secho(response_message, bold=True, fg="green")
+
+
 @simvue.group("admin")
 @click.pass_context
 def admin(ctx) -> None:
@@ -1619,15 +1691,23 @@ def list_storages(
     help="Specify target language",
     type=click.Choice(["python", "rust", "julia", "nodejs"]),
 )
-@click.option("--run", required=True, help="ID of run to clone environment from")
+@click.option(
+    "--run", required=False, help="ID of run to clone environment from", default=""
+)
 @click.option(
     "--allow-existing",
     is_flag=True,
     help="Install dependencies in an existing environment",
 )
 @click.argument("venv_directory", type=click.Path(exists=False))
 def venv_setup(ctx, **kwargs) -> None:
-    """Initialise virtual environments from run metadata."""
+    """Initialise virtual environments from run metadata.
+
+    If a run ID is not provided via --run it is read from stdin.
+    """
+    if not kwargs.get("run"):
+        kwargs["run"] = input()
+
     try:
         simvue_cli.actions.create_environment(**kwargs)
     except (FileExistsError, RuntimeError) as e:
@@ -1746,5 +1826,25 @@ def artifact_list(
     click.echo(table)
 
 
+@simvue_artifact.command("json")
+@click.pass_context
+@click.argument("artifact_id", required=False)
+def get_artifact_json(ctx, artifact_id: str) -> None:
+    """Retrieve artifact information from Simvue server
+
+    If no ARTIFACT_ID is provided the input is read from stdin
+    """
+    if not artifact_id:
+        artifact_id = input()
+
+    try:
+        artifact: Artifact = simvue_cli.actions.get_artifact(artifact_id)
+        artifact_info = artifact.to_dict()
+        click.echo(json.dumps(dict(artifact_info.items()), indent=2))
+    except ObjectNotFoundError as e:
+        error_msg = f"Failed to retrieve artifact '{artifact_id}': {e.args[0]}"
+        click.echo(error_msg, fg="red", bold=True)
+
+
 if __name__ in "__main__":
     simvue()

src/simvue_cli/cli/display.py

@@ -107,7 +107,7 @@ def format_tags(
     out_config["tags"] = out_config.get("tags") or {}
 
     if plain_text:
-        return ", ".join(tags)
+        return f"[{', '.join(tags)}]" if tags else ""
 
     tag_out: list[str] = []
 
@@ -129,7 +129,7 @@ def format_tags(
             out_config["tags"][tag] = color
         tag_out.append(click.style(tag, fg=CLICK_COLORS[color], bg=color, bold=True))
 
-    return ", ".join(tag_out)
+    return " ".join(tag_out)
 
 
 # Allocate functions to format each column type
@@ -174,12 +174,11 @@ def create_objects_display(
         either a click formatted string or original text
     """
 
-    if plain_text:
-        return " ".join(obj.id for _, obj in objects)
-
     # Remove 'is_' prefix from relevant columns and format
     table_headers = [
-        click.style(c.replace("is_", ""), bold=True)
+        c.replace("is_", "")
+        if plain_text
+        else click.style(c.replace("is_", ""), bold=True)
         for c in (("#", *columns) if enumerate_ else columns)
     ]
 
@@ -206,7 +205,7 @@ def create_objects_display(
                 row.append(str(value))
         contents.append(row)
 
-    if not format:
+    if not format or plain_text:
         objs_list: list[str] = ["\t".join(c) for c in contents]
         return "\n".join(objs_list)