magus v0.3.0 is out. See what's new
¶ View markdown source · ✎ Suggest an edit

magus-ls

List all discovered projects

Synopsis

magus ls [flags]

Description

Print every discovered project in the workspace along with its language pack, source files, outputs, dependencies, and tool requirements.

Output defaults to a human-readable text format. Use the global -o flag with json or yaml for structured output suitable for scripting. -o name prints one project path per line. -o template accepts a Go text/template evaluated against the value -o json emits, so its field names are the json keys.

Examples

List all projects

magus ls

Pipe-friendly: one path per line

magus ls -o name

JSON output

magus ls -o json

Custom Go template

magus ls -o template='{{range .projects}}{{.path}}{{"\n"}}{{end}}'

See Also

magus(1), magus-describe(1), magus-run(1), magus-x(1), magus-where(1), magus-affected(1), magus-insight(1), magus-graph(1), magus-watch(1), magus-status(1), magus-doctor(1), magus-config(1), magus-server(1), magus-completion(1), magus-man(1), magus-init(1), magus-self(1), magus-version(1)

auto-generatedclimagus lslistprojectsdiscoveryworkspace
Last updated (a59e71c9)
Earlier changes on this page (2)

Full history ↗ · Blame source ↗

Glossary

Workspace

The magus root directory that owns a set of projects and shared config; the unit magus operates over. See workspace.

Project

A directory magus recognizes as a unit of work (it has a magusfile); the unit of caching, scheduling, and dependency tracking. See workspace.

Affected

The set of projects touched by a change; magus affected <target> runs a target only over them. See affected.

CI

An ordinary magusfile-defined target you compose yourself with magus\needs - magus does not hardcode its stages. Magus.RunCI treats it specially only in that it strips the rw charm, it is the anchor magus affected ci keys off, and a selected scope with no project declaring it is a load error rather than a silent no-op. See targets.

MAGUS.md

The committed routing index at a workspace root, regenerated from the knowledge graph: it lists every node and points at the exact query for a given question, so it is the entry point an agent reads first. See knowledge.

Insight

The reports magus derives over the graph and history (hotspots, affinity, ownership, trend). See insight.

Conventions

This page uses none of the site's convention markers. The full set is on the conventions page.