feat: add more inspect subcommands

[miekg]

All uc subcommands should include inspect to get the raw json - docker solves this by having a rest service implemented on the socket that you can curl, so uc might need to do things slightly different.

% uc volume inspect     
Error: accepts 1 arg(s), received 0

instead of the above, so all volumes in json and make uc volume inspect VOL do what it does now.

% uc volume inspect atomdns_data   
  "MachineID": "212fd73438b53ebfb7dd531da4c6ed41",
  "MachineName": "machine-9q7y",
  "Volume": {
    "CreatedAt": "2026-04-24T11:23:14Z",
    "Driver": "local",
    "Labels": {
      "nl.ru.science.backup": "kopia",
      "uncloud.managed": ""
    },
    "Mountpoint": "/var/lib/docker/volumes/atomdns_data/_data",
    "Name": "atomdns_data",
    "Options": null,
    "Scope": "local"
  }
}

[psviderski]

I think we should agree on a consistent approach for listing/inspecting resources and formatting the data for humans and machines.

Docker approach

• docker RESOURCE ls - print a table of resources for humans
• docker RESOURCE inspect ID - print a detailed JSON for both humans and machines

Most commands accept a --format option:

      --format string   Format output using a custom template:
                        'table':            Print output in table format with column headers (default)
                        'table TEMPLATE':   Print output in table format using the given Go template
                        'json':             Print in JSON format
                        'TEMPLATE':         Print output using the given Go template.

For example, to list all volumes formatted as JSON:

docker volume ls --format json

The Go template formatting is very powerful and often used for scripting:

docker inspect --format "{{lower .Name}}" CONTAINER

kubectl approach

kubectl has a similar to Docker option called --output for formatting the command output:

    -o, --output='':
        Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath,
        jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). See custom columns
        [https://kubernetes.io/docs/reference/kubectl/#custom-columns], golang template
        [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template
        [https://kubernetes.io/docs/reference/kubectl/jsonpath/].

I personally used -o wide and -o yaml a lot.

My thoughts

I think the uc RESOURCE ls/inspect output should be human-readable by default. uc volume inspect returning a JSON was just a shortcut (at least not worse than Docker) but I think we should do a better job at formatting the volume info in a human-friendly way. The same for all new commands inspecting a machine, image, container. Note that inspecting a service is already displays a human-friendly output.

Then if one needs a machine-readable format, we need to add a way to toggle that for the same command. A flag is the obvious option.

Options:

• --format/--output - similar to kubectl and Docker. Flexible and easily allows extending the supported formats, e.g. Go template, json, yaml
• --json - only JSON. Less flexible but super simple, relies on other utils such as jq to extract any data from it in scripts

I like the simplicity of --json but also appreciate the power and flexibility of template formatting. Maybe we should start with -o json and then see if we want to support other formats.

Here was an attempt to abstract table data and support JSON output: #191

I wouldn't try to create a perfect abstraction right away. It's easier to create a few adhoc implementation and then see what they have in common and come up with better abstractions.

[miekg]

-o json sounds like a very good plan. I'll rework this PR into one that does this for all commands. May fixup volume inspect, but that should prolly be a seperate issue, and, we need to figure out a presentation format for inspect as this may not for in a table...?

…

On Wed, Apr 29, 2026, 12:12 Pasha Sviderski ***@***.***> wrote: *psviderski* left a comment (psviderski/uncloud#338) <#338 (comment)> I think we should agree on a consistent approach for listing/inspecting resources and formatting the data for humans and machines. Docker approach - docker RESOURCE ls - print a table of resources for humans - docker RESOURCE inspect ID - print a detailed JSON for both humans and machines Most commands accept a --format option: --format string Format output using a custom template: 'table': Print output in table format with column headers (default) 'table TEMPLATE': Print output in table format using the given Go template 'json': Print in JSON format 'TEMPLATE': Print output using the given Go template. For example, to list all volumes formatted as JSON: docker volume ls --format json The Go template formatting is very powerful and often used for scripting: docker inspect --format "{{lower .Name}}" CONTAINER kubectl approach kubectl has a similar to Docker options --output for formatting the command output: -o, --output='': Output format. One of: (json, yaml, name, go-template, go-template-file, template, templatefile, jsonpath, jsonpath-as-json, jsonpath-file, custom-columns, custom-columns-file, wide). See custom columns [https://kubernetes.io/docs/reference/kubectl/#custom-columns], golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [https://kubernetes.io/docs/reference/kubectl/jsonpath/]. I personally used -o wide and -o yaml a lot. My thoughts I think the uc RESOURCE ls/inspect output should be human-readable by default. uc volume inspect returning a JSON was just a shortcut (at least not worse than Docker) but I think we should do a better job at formatting the volume info in a human-friendly way. Then if one need a machine-readable format, we need to add a way to toggle that for the same command. A flag is the obvious option. Options: - --format/--output - similar to kubectl and Docker. Flexible and easily allows extending the supported formats, e.g. Go template, json, yaml - --json - only JSON. Less flexible but super simple, relies on other utils such as jq to extract any data from it in scripts I like the simplicity of --json but also appreciate the power and flexibility of template formatting. Maybe we should start with -o json and then see if we want to support other formats. — Reply to this email directly, view it on GitHub <#338 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACWIW4F6NLAC5N7SO4PUML4YHISJAVCNFSM6AAAAACYHMCBLOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DGNBSG43DANRYHA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you authored the thread.Message ID: ***@***.***>

[miekg]

In your view should 'showalso get an--output=json? Or shouldwg showbe renamed towg ls` ?