@pixlcore/xycli 1.0.0

package/docs/screenshots.md

@@ -0,0 +1,219 @@
+# xyCLI Screenshots
+
+Take a tour of xyCLI, from launching jobs to investigating server health and managing your automation. Click any screenshot to open the full-size image.
+
+Return to the [README](../README.md) or explore the [command reference](help.md).
+
+## Dashboard and system
+
+### Dashboard
+
+![xyCLI dashboard](https://pixlcore.com/software/xycli/screenshots/dashboard.png)
+
+*See server health, active Alerts and jobs, queued work, and rate limits at a glance.*
+
+### System dashboard
+
+![Administrator System dashboard](https://pixlcore.com/software/xycli/screenshots/system.png)
+
+*Inspect conductor status, process and database statistics, internal jobs, and connected users.*
+
+### System logs
+
+![xyOps system log output](https://pixlcore.com/software/xycli/screenshots/log.png)
+
+*Read color-coded system log rows and search for the details you need while troubleshooting.*
+
+## Events and jobs
+
+### Event list
+
+![Events organized by Category](https://pixlcore.com/software/xycli/screenshots/event-list.png)
+
+*Browse Events by Category, with their Plugins, targets, schedules, and current activity.*
+
+### Job launch
+
+![Launching and following a job](https://pixlcore.com/software/xycli/screenshots/job-launch.png)
+
+*Launch an Event and follow its output through to the completed job report.*
+
+## Servers
+
+### Server list
+
+![Server list and selected server details](https://pixlcore.com/software/xycli/screenshots/server-list.png)
+
+*Find workers and drill into a server's system information and current activity.*
+
+### Memory and CPU
+
+![Server memory and CPU details](https://pixlcore.com/software/xycli/screenshots/server-mem-cpu.png)
+
+*Explore memory usage, CPU details, and Quick Look charts for a single worker.*
+
+### Monitor charts
+
+![Server monitoring charts](https://pixlcore.com/software/xycli/screenshots/server-monitors.png)
+
+*Chart a server's collected metrics directly in the terminal.*
+
+### Processes and connections
+
+![Server processes and network connections](https://pixlcore.com/software/xycli/screenshots/server-procs-conns.png)
+
+*Inspect running processes and network connections alongside the server's monitoring context.*
+
+## Server Groups
+
+### Group details
+
+![Server Group summary and member servers](https://pixlcore.com/software/xycli/screenshots/group-details.png)
+
+*View Group settings and member servers together before exploring their combined health.*
+
+### Group Alerts and jobs
+
+![Alerts and jobs across a Server Group](https://pixlcore.com/software/xycli/screenshots/group-alerts-jobs.png)
+
+*See active Alerts and jobs across a pool of workers in one combined view.*
+
+### Group Quick Look charts
+
+![Aggregated Group Quick Look charts](https://pixlcore.com/software/xycli/screenshots/group-quickmon.png)
+
+*Explore short-term monitoring charts aggregated across the Group's servers.*
+
+### Group Monitor charts
+
+![Aggregated Group Monitor charts](https://pixlcore.com/software/xycli/screenshots/group-monitors.png)
+
+*Follow the Group's collected metrics with terminal charts for each Monitor.*
+
+### Group processes
+
+![Processes across a Server Group](https://pixlcore.com/software/xycli/screenshots/group-processes.png)
+
+*Compare processes across member servers to spot busy applications and unusual resource usage.*
+
+## Monitors, Alerts, and snapshots
+
+### Monitor definitions
+
+![Monitor list and definition details](https://pixlcore.com/software/xycli/screenshots/monitors.png)
+
+*Browse metric definitions and inspect their source expressions, display settings, and scope.*
+
+### Alert definitions
+
+![Alert definition list and details](https://pixlcore.com/software/xycli/screenshots/alert-list-detail.png)
+
+*Review Alert expressions, messages, settings, and configured actions.*
+
+### Alert search
+
+![Alert invocation search results](https://pixlcore.com/software/xycli/screenshots/alert-search.png)
+
+*Search actual Alert occurrences to investigate affected servers, timing, and status.*
+
+### Snapshot list
+
+![Saved Server and Group snapshots](https://pixlcore.com/software/xycli/screenshots/snapshot-list.png)
+
+*Browse point-in-time captures created by users, watches, jobs, and Alerts.*
+
+## Organization and notifications
+
+### Categories
+
+![Category list and details](https://pixlcore.com/software/xycli/screenshots/categories.png)
+
+*Organize Events and inspect the shared actions and limits applied through their Category.*
+
+### Tags
+
+![Tag list and details](https://pixlcore.com/software/xycli/screenshots/tags.png)
+
+*Manage reusable labels for finding related Events, jobs, and Tickets.*
+
+### Notification Channels
+
+![Notification Channel list and details](https://pixlcore.com/software/xycli/screenshots/channels.png)
+
+*Inspect reusable recipients and follow-up actions for your automation's notifications.*
+
+### Web Hooks
+
+![Web Hook list and details](https://pixlcore.com/software/xycli/screenshots/web-hooks.png)
+
+*Review outbound HTTP integrations, including their URLs, headers, and request bodies.*
+
+## Data and access
+
+### Storage Buckets
+
+![Storage Bucket list and contents](https://pixlcore.com/software/xycli/screenshots/buckets.png)
+
+*Browse durable storage and inspect the JSON data and files shared by jobs and workflows.*
+
+### Secret Vaults
+
+![Secret Vault metadata and assignments](https://pixlcore.com/software/xycli/screenshots/secrets.png)
+
+*View variable names and Vault assignments while keeping secret values out of normal reports.*
+
+### API Keys
+
+![API Key metadata and settings](https://pixlcore.com/software/xycli/screenshots/api-keys.png)
+
+*Inspect key status, privileges, and other access settings using safe metadata.*
+
+## Plugins and Marketplace
+
+### Plugin list
+
+![Installed Plugin definitions](https://pixlcore.com/software/xycli/screenshots/plugin-list.png)
+
+*Browse the Event, Monitor, Action, and Scheduler Plugins available to your automation.*
+
+### Plugin details and update
+
+![Plugin details and update output](https://pixlcore.com/software/xycli/screenshots/plugin-detail-update.png)
+
+*Inspect a Plugin's executable and parameters, then update its definition from the CLI.*
+
+### Marketplace list
+
+![Plugin Marketplace search results](https://pixlcore.com/software/xycli/screenshots/marketplace-list.png)
+
+*Discover Plugins and compare their types, authors, requirements, and installation status.*
+
+### Marketplace product
+
+![Marketplace Plugin details and README](https://pixlcore.com/software/xycli/screenshots/marketplace-product.png)
+
+*Read a Plugin's description and rendered README before deciding to install it.*
+
+## Tickets
+
+### Ticket list
+
+![Ticket search results](https://pixlcore.com/software/xycli/screenshots/ticket-list.png)
+
+*Find operational work by status, assignee, Category, Tags, and other search criteria.*
+
+### Ticket details
+
+![Ticket details and Markdown content](https://pixlcore.com/software/xycli/screenshots/ticket-detail.png)
+
+*Read descriptions and comments alongside attached Events, jobs, and files.*
+
+## Filesystem sync
+
+### Sync
+
+![Filesystem sync output](https://pixlcore.com/software/xycli/screenshots/sync.png)
+
+*Review changes between local definition files and xyOps as part of an editor and Git workflow.*
+
+See the [Sync Guide](sync.md), [sync overview](../README.md#sync-your-automation-with-local-files), and [sync command reference](help.md#sync).