Skip to main content
Version: 2.5.0

CLI API Reference

Full flag reference for the client_admin binary.

Syntax

client_admin [flags] [arguments]

Flags

Mode Flags

FlagArgumentsDescription
-iLaunch interactive mode (REPL)
-f<script>Execute commands from a script file

Chronicle Operations

FlagArgumentsDescription
-c<chronicle>Create a Chronicle with the given name
-d -c<chronicle>Destroy a Chronicle

Story Operations

FlagArgumentsDescription
-a -s<chronicle> <story>Acquire (open) a Story in a Chronicle
-q -s<chronicle> <story>Release a Story in a Chronicle
-d -s<chronicle> <story>Destroy a Story in a Chronicle

Event Operations

FlagArgumentsDescription
-w<event>Write an Event with the given string payload

Connection

FlagArgumentsDescription
-disconnectDisconnect from the ChronoLog server

Optional Modifiers

FlagArgumentsDescription
--perfCollect and report performance metrics for operations
--shared_storyEnable collaborative (shared) Story access for testing

Notes

  • -d is used for both Chronicle and Story destruction; the object type is determined by the subsequent -c or -s flag.
  • -a -s must be called before -w — Events are written into the currently acquired Story.
  • In scripted mode (-f), each line of the script file is treated as a separate invocation.