add timeline rename functionality to timesketch cli tool (#3156)

Co-authored-by: Janosch <[email protected]>

cli_client/python/timesketch_cli_client/commands/timelines.py

@@ -77,3 +77,36 @@ def describe_timeline(ctx, timeline_id):
             click.echo(f"\tOriginal filename: {original_filename}")
             click.echo(f"\tFile on disk: {file_on_disk}")
             click.echo(f"\tError: {error_message}")
+
+
+@timelines_group.command("rename")
+@click.argument("timeline-id", type=int, required=True)
+@click.argument("new-name", type=str, required=True)
+@click.pass_context
+def rename_timeline(ctx, timeline_id, new_name):
+    """Rename a timeline.
+
+    Args:
+        ctx: Click CLI context object.
+        timeline-id: Timeline ID from argument.
+        new-name: New Timeline name
+    """
+    sketch = ctx.obj.sketch
+    output = ctx.obj.output_format
+    timeline = sketch.get_timeline(timeline_id=timeline_id)
+    if not timeline:
+        click.echo("No such timeline")
+        return
+    timeline.lazyload_data()
+
+    # Set new name
+    timeline.name = new_name
+
+    # Print output depending on output settings
+    if output == "json":
+        click.echo(f"{timeline.resource_data}")
+        return
+    if output != "text":
+        click.echo(f'Unsupported output format: "{output}" - using "text" instead')
+    else:
+        click.echo(f"New name: {timeline.name}")

docs/guides/user/cli-client.md

@@ -504,4 +504,27 @@ It is also possible to provide a comma separated list of tags to remove. The fol
 ```bash
 timesketch events remove_tag --timeline-id 4 --event-id k8P1MYcBkeTGnypeeKJL --tag foobar333,fooba123
 200
-```
+```
+
+## Timelines
+
+### List timelines
+
+To list all timelines in a given sketch use: `timelines list`.
+
+```bash
+timesketch --sketch 1 timelines list
+1 foobar
+2 foobar3
+```
+
+It is also possible to get all the output as JSON.
+
+### Rename timeline
+
+To rename a single timeline in a sketch, the command `timelines rename` can be used.
+
+```bash
+timesketch --sketch 1 timelines rename 1 foobar23
+```
+