zelos

The Zelos command-line interface (CLI)

This multi-tool binary can be run with a variety of sub-commands.

Feature:

• Creating a new project
• Launching a trace server for ZPlot
• APIs for specific codecs/links

For more help, run --help/-h on any command (e.g., zelos create --help).

Usage:

zelos [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--version	boolean	Show the version and exit.	False
--help	boolean	Show this message and exit.	False

Subcommands

• create: Create different types of resources.
• login: Log into the Zelos Console.
• test: Run tests via pytest
• trace: Manipulate trace files.
• upload: Upload a trace folder to the Zelos Console.

zelos create

Create different types of resources.

Usage:

zelos create [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• project: Creates a new project from a template.

zelos create project

Creates a new project from a template.

Creates the folder PROJECT_NAME, with the features specified.

Available features:

• can: Enables CAN network capabilities. (-f can)
• serial: Includes support for serial communication. (-f serial)
• uds: Adds UDS protocol support. (-f uds)
• visa: Includes support for VISA based instrumentation devices. (-f visa)

Usage:

zelos create project [OPTIONS] PROJECT_NAME

Options:

Name	Type	Description	Default
-d, --destination	text	Destination directory where the project should be created.	.
-f, --feature	choice (can | serial | uds | visa)	Select features to include in the project. Features are appended (e.g., -f can -f serial).	None
--help	boolean	Show this message and exit.	False

zelos login

Log into the Zelos Console.

For this command to work, you must have completed onboarding and either created or joined an organization. Your credentials will be saved to the file $HOME/.config/zelos/credentials.json; you can log out by deleting the file.

Usage:

zelos login [OPTIONS]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

zelos test

Run tests via pytest

Usage:

zelos test [OPTIONS] [ARGV]...

Options:

Name	Type	Description	Default
-h, --help	boolean	Print help options	False

zelos trace

Manipulate trace files.

Usage:

zelos trace [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• capture: Capture data to a .trz trace file.
• convert: Convert log formats to Zelos traces.

zelos trace capture

Capture data to a .trz trace file.

• --output defaults to the file CURRENT_TIMESTAMP.trz in the current working directory.

Usage:

zelos trace capture [OPTIONS]

Options:

Name	Type	Description	Default
--output	Path	N/A	None
--can	from_str	CAN bus device to listen to, in format [INTERFACE://]DEVICE[:BITRATE][:DBC_FILE]. Default INTERFACE is 'socketcan'. Example: 'can0:example.dbc' or 'pcan://PCAN_USBBUS1:500000:example.dbc'	None
--verbose, -v	boolean	Enable verbose logging	False
--quiet	boolean	Suppress all logging output to the console	False
--force, -f	boolean	Overwrite output file if it exists	False
--print	boolean	Print trace events	False
--config, -c	Path	Station config file path	None
--override, -o	text	Override station config options, in key=value syntax	None
--help	boolean	Show this message and exit.	False

zelos trace convert

Convert log formats to Zelos traces.

Usage:

zelos trace convert [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Subcommands

• can: Convert a CAN bus log to Zelos trace.

zelos trace convert can

Convert a CAN bus log to Zelos trace.

• FILE is a file with a supported extension: .asc, .blf, .csv, .db, .log, .mf4, .trc
• DBC is the .dbc file used to decode the can data.
• OUTPUT defaults to the folder FILE_BASENAME.trz in the current working directory.

Usage:

zelos trace convert can [OPTIONS] FILE DBC [OUTPUT]

Options:

Name	Type	Description	Default
-f, --force	boolean	Delete OUTPUT if it exists	False
-v, --verbose	boolean	Print debug logs	False
--print	boolean	Print trace events	False
--help	boolean	Show this message and exit.	False

zelos upload

Upload a trace folder to the Zelos Console.

If you are not currently logged in, this command will log you in before initiating the upload.

Usage:

zelos upload [OPTIONS] FOLDER

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False