m/cup
1
0
Fork 0
mirror of https://github.com/sergi0g/cup.git synced 2025-11-17 01:23:39 -05:00
Code Wiki Activity

Update docs about JSON CLI output, fix small typo on homepage

Browse Source
This commit is contained in:
Sergio
2025-02-07 17:32:19 +02:00
parent 0314ef2f05
commit a0de565367
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/src/app/components/pages/home.tsx
View File

@@ -97,7 +97,7 @@ export default async function Home() {
/>
<Card
name="Both CLI and web interface"
description="Whether you prefer the command line, or the web, Cup runs wherever you choose."
description="Whether you prefer the command line or the web, Cup runs wherever you choose."
icon={IconDevices}
/>
<Card

5
docs/src/content/docs/usage/cli.mdx
View File

@@ -1,5 +1,6 @@
import Image from "next/image";
import cup from "@/app/assets/cup.gif";
import { Callout } from "nextra/components";
# CLI
@@ -60,6 +61,10 @@ $ cup check -r
{"metrics":{"monitored_images":26,"up_to_date":2,"updates_available":23,"major_updates":8,"minor_updates":6,"patch_updates":2,"other_updates":7,"unknown":1},"images":{"ghcr.io/immich-app/immich-server:v1.106.4":false,"portainer/portainer-ce:2.20.3-alpine":false,"ghcr.io/runtipi/runtipi:v3.4.1":false,...}}
```
<Callout emoji="⚠️">
When parsing Cup's output, capture only `stdout`, otherwise you might not get valid JSON (if there are warnings)
</Callout>
## Usage with Docker
If you're using the Docker image, just replace all occurences of `cup` in the examples with `docker run -tv /var/run/docker.sock:/var/run/docker.sock ghcr.io/sergi0g/cup`.