Command line | Plexora

Plexora installs one command, plexora. On its own it starts the viewer and opens it in your browser. The subcommands below say where data lives, start Plexora on another machine, serve files to a viewer elsewhere, and register projects and datasets without opening the viewer.

Every command accepts --help. Options shown here are generated from the command's own definition, so they match the installed version.

Command	What it does
`plexora`	Start the Plexora local image viewer server.
`plexora where`	Print the resolved data directory and how it was chosen.
`plexora config`	Show or change where Plexora keeps its data.
`plexora config show`	Print the current settings file.
`plexora config set`	Change a setting.
`plexora connect`	Start Plexora on a remote host, tunnel to it, and open a browser here. Run this on your OWN computer, not on the remote host.
`plexora node`	Serve data files to a Plexora viewer running elsewhere. A node has no viewer and no project registry of its own -- it hands out bytes from the files it is pointed at.
`plexora node serve`	Serve one or more files to a Plexora viewer.
`plexora node connect`	Start a data node on another machine and register it here.
`plexora node prepare`	Convert a label mask into something a node can serve.
`plexora dataset`	Group projects into datasets -- a cohort, a TMA series, one imaging run.
`plexora dataset create`	Make a dataset, registering its images if needed.
`plexora dataset list`	Every dataset on this machine.
`plexora dataset show`	One dataset and what is in it.
`plexora dataset add`	Put existing projects in a dataset.
`plexora dataset remove`	Take projects out of a dataset. They are NOT deleted.
`plexora dataset rename`	Rename a dataset.
`plexora dataset delete`	Delete a dataset. The projects in it stay.
`plexora project`	Register a project from an image, and fill in what it needs as you find out.
`plexora project create`	Register a project from an image, files, or a run folder.
`plexora project show`	What a project has, and what is still open.
`plexora project export`	Write projects to one .plexora file: their own work, their tables, bookmarks and figures; their images only when asked.
`plexora project import`	Add the projects in a .plexora file to this computer's projects.
`plexora project set`	Answer a question about a registered project.