cli/internal/cmd/unifi/cmd_devices.go
Snider 76332b0f02
Add User Documentation (User Guide, FAQ, Troubleshooting) (#307)
* docs: add user guide, faq, and enhance troubleshooting

- Created docs/user-guide.md with key concepts and workflows.
- Created docs/faq.md with common questions and answers.
- Enhanced docs/troubleshooting.md with AI/Agentic issues.
- Updated README.md with CLI Quick Start and Getting Help sections.
- Refactored mkdocs.yml to reflect actual file structure and include new docs.

* docs: add user documentation and fix mkdocs navigation

- Created docs/user-guide.md and docs/faq.md.
- Enhanced docs/troubleshooting.md with AI/Agentic issues.
- Updated README.md with CLI Quick Start and Help links.
- Restored original mkdocs.yml navigation and added new user documentation sections.
- Fixed formatting in pkg/io/local/client.go to ensure CI passes.

* docs: add user documentation and fix auto-merge workflow

- Created docs/user-guide.md and docs/faq.md with user-focused content.
- Enhanced docs/troubleshooting.md with AI/Agentic issue solutions.
- Updated README.md with CLI Quick Start and organized help links.
- Refactored mkdocs.yml to include new documentation while preserving technical sections.
- Fixed .github/workflows/auto-merge.yml by inlining the logic and adding git repository context (checkout and -R flag) to resolve CI failures.
- Verified that docs/workflows.md is present in the repository.

* docs: add user documentation and resolve merge conflict

- Created docs/user-guide.md and docs/faq.md.
- Enhanced docs/troubleshooting.md with AI/Agentic issue solutions.
- Updated README.md with CLI Quick Start and Help sections.
- Merged latest base branch changes and resolved conflict in .github/workflows/auto-merge.yml.
- Verified and organized mkdocs.yml navigation.

* docs: add user documentation and fix UniFi security issue

- Created docs/user-guide.md and docs/faq.md.
- Enhanced docs/troubleshooting.md.
- Updated README.md with CLI Quick Start.
- Fixed UniFi security vulnerability (CodeQL alert) by making TLS verification configurable.
- Added --insecure flag to UniFi CLI commands.
- Verified all documentation links and navigation.

* docs: add user documentation and fix formatting/security

- Created docs/user-guide.md and docs/faq.md.
- Enhanced docs/troubleshooting.md.
- Updated README.md with CLI Quick Start.
- Fixed UniFi security vulnerability by making TLS verification configurable.
- Added --insecure flag to UniFi CLI commands.
- Fixed formatting in internal/cmd/unifi/cmd_config.go.
- Verified all documentation links and navigation.

---------

Co-authored-by: Claude <developers@lethean.io>
2026-02-05 06:55:52 +00:00

74 lines
1.7 KiB
Go

package unifi
import (
"strings"
"github.com/host-uk/core/pkg/cli"
"github.com/host-uk/core/pkg/log"
uf "github.com/host-uk/core/pkg/unifi"
)
// Devices command flags.
var (
devicesSite string
devicesType string
)
// addDevicesCommand adds the 'devices' subcommand for listing infrastructure devices.
func addDevicesCommand(parent *cli.Command) {
cmd := &cli.Command{
Use: "devices",
Short: "List infrastructure devices",
Long: "List all infrastructure devices (APs, switches, gateways) on the UniFi network.",
RunE: func(cmd *cli.Command, args []string) error {
return runDevices()
},
}
cmd.Flags().StringVar(&devicesSite, "site", "", "Filter by site name")
cmd.Flags().StringVar(&devicesType, "type", "", "Filter by device type (uap, usw, usg, udm, uxg)")
parent.AddCommand(cmd)
}
func runDevices() error {
client, err := uf.NewFromConfig("", "", "", "", nil)
if err != nil {
return log.E("unifi.devices", "failed to initialise client", err)
}
devices, err := client.GetDeviceList(devicesSite, strings.ToLower(devicesType))
if err != nil {
return log.E("unifi.devices", "failed to fetch devices", err)
}
if len(devices) == 0 {
cli.Text("No devices found.")
return nil
}
table := cli.NewTable("Name", "IP", "MAC", "Model", "Type", "Version", "Status")
for _, d := range devices {
status := successStyle.Render("online")
if d.Status != 1 {
status = errorStyle.Render("offline")
}
table.AddRow(
valueStyle.Render(d.Name),
d.IP,
dimStyle.Render(d.Mac),
d.Model,
dimStyle.Render(d.Type),
dimStyle.Render(d.Version),
status,
)
}
cli.Blank()
cli.Print(" %d devices\n\n", len(devices))
table.Render()
return nil
}