Add project readiness status

Author: RamazanKara

CHANGELOG.md

@@ -31,6 +31,7 @@
 - Added identity realm/client candidate validation for the Okta/Auth0 assessment path.
 - Added edge VCL, HAProxy, and Coraza candidate validation for the Cloudflare/Akamai assessment path.
 - Added LiteLLM/vLLM config candidate validation for the OpenAI/Anthropic assessment path.
+- Added project readiness status with pipeline summaries, export readiness, next actions, and `--json` output.
 - Updated CI and release workflows to Node.js 24-native GitHub Actions.
 
 ## 0.1.0 - 2026-05-24

README.md

@@ -57,7 +57,7 @@ make example VERSION=0.1.0-dev
 
 - `openexit version`
 - `openexit init <project-dir> [--source <type> --target <type>]`
-- `openexit status --project <project-dir>`
+- `openexit status --project <project-dir> [--json]`
 - `openexit collect fixture --project <project-dir> --input <file>`
 - `openexit collect github --project <project-dir> --owner <org> [--base-url https://github.example.com/api/v3] [--token-env GITHUB_TOKEN] [--repo owner/name]`
 - `openexit collect github-fixture --project <project-dir> --input <file>`
@@ -98,6 +98,7 @@ Fixture workflows run the full local OpenExit workflow with sample or customer-p
 Included in the current implementation:
 
 - CLI skeleton and project init/status.
+- Project readiness status with pipeline counts, validation state, export readiness, and JSON output for automation.
 - Typed project, inventory, assessment, mapping, and validation manifests.
 - Fixture-based Datadog inventory import.
 - Read-only Datadog collection for dashboards, monitors, SLOs, installed integration metadata, and referenced metric/tag metadata.

docs/cli.md

@@ -27,6 +27,8 @@ The CI test suite also runs this definition-of-done pipeline against the fixture
 
 The checked-in Datadog example can be refreshed with `make example VERSION=0.1.0-dev`. CI also runs `make example-smoke` as part of `make verify` to ensure the example fixture still completes the full pipeline.
 
+`openexit status --project <project-dir>` summarizes the current pipeline state: project layout, source/target pair, inventory counts, assessment finding severity, mapping counts, generated candidate artifacts, validation check totals, export readiness, and the next recommended command. Use `--json` to feed the same readiness data into automation or release gates.
+
 `openexit validate` performs typed consistency checks, embedded JSON Schema validation, Grafana dashboard candidate validation, Prometheus alert-rule candidate validation, OpenTelemetry collector candidate validation, ArgoCD candidate validation, Forgejo migration candidate validation, identity realm/client candidate validation, edge VCL/HAProxy/Coraza candidate validation, LiteLLM/vLLM candidate validation, YAML/JSON parse checks, evidence reference checks, secret scanning, and optional external tool checks when `promtool` or `kubeconform` are installed.
 
 `openexit export` refuses to package symlinks from exported project sections, even with `--force`, so evidence bundles cannot accidentally include files from outside the project tree.

docs/release.md

@@ -8,7 +8,7 @@ The implementation plan names Datadog to Grafana LGTM, Prometheus-compatible ale
 
 Release-blocking v0.1 requirements:
 
-- CLI skeleton, project init/status, version command.
+- CLI skeleton, project init, readiness status, version command.
 - Datadog fixture collector and read-only live Datadog collector.
 - Inventory and assessment manifests with typed validation.
 - Source-to-target mapping manifest with candidate paths and manual-review entries.
@@ -41,6 +41,7 @@ The AI provider path is complete for local fixture assessment workflows and incl
   `init`, `collect fixture`, `assess`, `map`, `generate --all`, `validate`, `export`.
 - [ ] GitHub, Okta, Auth0, Cloudflare, Akamai, OpenAI, and Anthropic fixture/live-collector test coverage pass, and supported fixture provider pipelines validate.
 - [ ] `openexit version` prints name, version, commit, and date from release build flags.
+- [ ] `openexit status --project <demo>` reports inventory, assessment, mapping, generated artifacts, validation status, export readiness, and matching `--json` output.
 - [ ] `README.md`, `docs/cli.md`, `docs/security.md`, and this checklist reflect current behavior.
 - [ ] `examples/datadog-to-grafana/README.md` reproduces the primary local demo.
 - [ ] `assessment/openexit.migration-plan.yaml`, `.json`, and `migration-plan.md` are generated by the demo pipeline and included in exported bundles.

internal/app/command.go

@@ -4,8 +4,10 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"io"
 	"os"
 	"path/filepath"
+	"sort"
 	"strconv"
 	"strings"
 	"time"
@@ -79,25 +81,152 @@ func newInitCommand() *cobra.Command {
 
 func newStatusCommand() *cobra.Command {
 	var project string
+	var jsonOutput bool
 	cmd := &cobra.Command{
 		Use:   "status",
-		Short: "Validate an OpenExit project layout",
+		Short: "Show OpenExit project readiness",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			status, err := CheckProject(project)
+			if jsonOutput {
+				enc := json.NewEncoder(cmd.OutOrStdout())
+				enc.SetIndent("", "  ")
+				if encErr := enc.Encode(status); encErr != nil {
+					return encErr
+				}
+				return err
+			}
 			if err != nil {
 				return err
 			}
+			writeProjectStatus(cmd.OutOrStdout(), status)
 			if len(status.Missing) > 0 {
 				return fmt.Errorf("project is missing required directories: %s", strings.Join(status.Missing, ", "))
 			}
-			_, _ = fmt.Fprintf(cmd.OutOrStdout(), "project ok: %s\n", status.ProjectDir)
 			return nil
 		},
 	}
 	cmd.Flags().StringVar(&project, "project", ".", "OpenExit project directory")
+	cmd.Flags().BoolVar(&jsonOutput, "json", false, "Write machine-readable project status")
 	return cmd
 }
 
+func writeProjectStatus(w io.Writer, status *ProjectStatus) {
+	_, _ = fmt.Fprintf(w, "project: %s\n", status.ProjectDir)
+	_, _ = fmt.Fprintf(w, "source: %s\n", status.Source)
+	_, _ = fmt.Fprintf(w, "target: %s\n", status.Target)
+	if len(status.Missing) > 0 {
+		_, _ = fmt.Fprintf(w, "layout: missing %s\n", strings.Join(status.Missing, ", "))
+	} else {
+		_, _ = fmt.Fprintln(w, "layout: ok")
+	}
+	_, _ = fmt.Fprintf(w, "inventory: %s\n", formatInventoryStatus(status.Inventory))
+	_, _ = fmt.Fprintf(w, "assessment: %s\n", formatAssessmentStatus(status.Assessment))
+	_, _ = fmt.Fprintf(w, "mapping: %s\n", formatMappingStatus(status.Mapping))
+	_, _ = fmt.Fprintf(w, "generated: %s\n", formatGeneratedStatus(status.Generated))
+	_, _ = fmt.Fprintf(w, "validation: %s\n", formatValidationStatus(status.Validation))
+	if status.ReadyForExport {
+		_, _ = fmt.Fprintln(w, "export-ready: yes")
+	} else {
+		_, _ = fmt.Fprintln(w, "export-ready: no")
+	}
+	for _, action := range status.NextActions {
+		_, _ = fmt.Fprintf(w, "next: %s\n", action)
+	}
+}
+
+func formatInventoryStatus(status InventoryStatus) string {
+	if !status.Present {
+		return "missing"
+	}
+	text := "present"
+	if counts := formatCounts(status.Assets); counts != "" {
+		text += " (" + counts + ")"
+	}
+	if status.Warnings > 0 {
+		text += fmt.Sprintf(" warnings=%d", status.Warnings)
+	}
+	if status.Error != "" {
+		text += " error=" + status.Error
+	}
+	return text
+}
+
+func formatAssessmentStatus(status AssessmentStatus) string {
+	if !status.Present {
+		return "missing"
+	}
+	parts := []string{fmt.Sprintf("findings=%d", status.Findings)}
+	if severity := formatCounts(status.Severity); severity != "" {
+		parts = append(parts, severity)
+	}
+	if status.Score > 0 {
+		parts = append(parts, fmt.Sprintf("score=%d", status.Score))
+	}
+	if status.Level != "" {
+		parts = append(parts, "level="+status.Level)
+	}
+	if status.Warnings > 0 {
+		parts = append(parts, fmt.Sprintf("warnings=%d", status.Warnings))
+	}
+	text := "present (" + strings.Join(parts, " ") + ")"
+	if status.Error != "" {
+		text += " error=" + status.Error
+	}
+	return text
+}
+
+func formatMappingStatus(status MappingStatus) string {
+	if !status.Present {
+		return "missing"
+	}
+	text := fmt.Sprintf("present (dashboardDrafts=%d alertRuleDrafts=%d unsupportedItems=%d manualReview=%d)", status.DashboardDrafts, status.AlertRuleDrafts, status.UnsupportedItems, status.ManualReview)
+	if status.Error != "" {
+		text += " error=" + status.Error
+	}
+	return text
+}
+
+func formatGeneratedStatus(status GeneratedStatus) string {
+	if !status.Present {
+		if status.Error != "" {
+			return "missing error=" + status.Error
+		}
+		return "missing"
+	}
+	text := fmt.Sprintf("present (files=%d candidates=%d)", status.Files, status.Candidates)
+	if status.Error != "" {
+		text += " error=" + status.Error
+	}
+	return text
+}
+
+func formatValidationStatus(status ValidationStatus) string {
+	if !status.Present {
+		return "missing"
+	}
+	text := fmt.Sprintf("%s (checks=%d passed=%d failed=%d warnings=%d)", status.Status, status.Checks, status.Passed, status.Failed, status.Warnings)
+	if status.Error != "" {
+		text += " error=" + status.Error
+	}
+	return text
+}
+
+func formatCounts(counts map[string]int) string {
+	if len(counts) == 0 {
+		return ""
+	}
+	keys := make([]string, 0, len(counts))
+	for key := range counts {
+		keys = append(keys, key)
+	}
+	sort.Strings(keys)
+	parts := make([]string, 0, len(keys))
+	for _, key := range keys {
+		parts = append(parts, fmt.Sprintf("%s=%d", key, counts[key]))
+	}
+	return strings.Join(parts, " ")
+}
+
 func newCollectCommand() *cobra.Command {
 	collectCmd := &cobra.Command{
 		Use:   "collect",

internal/app/e2e_test.go

@@ -5,6 +5,7 @@ import (
 	"bytes"
 	"crypto/sha256"
 	"encoding/hex"
+	"encoding/json"
 	"io"
 	"os"
 	"path/filepath"
@@ -52,6 +53,61 @@ func TestDefinitionOfDonePipelineAndBundle(t *testing.T) {
 	}
 }
 
+func TestStatusReportsPipelineReadiness(t *testing.T) {
+	projectDir := filepath.Join(t.TempDir(), "demo")
+	fixturePath := filepath.Join("..", "..", "testdata", "datadog", "small.json")
+
+	commands := [][]string{
+		{"init", projectDir},
+		{"collect", "fixture", "--project", projectDir, "--input", fixturePath},
+		{"assess", "--project", projectDir, "--target", "grafana-lgtm"},
+		{"map", "--project", projectDir},
+		{"generate", "--project", projectDir, "--all"},
+		{"validate", "--project", projectDir},
+	}
+	for _, args := range commands {
+		if err := executeForTest(args...); err != nil {
+			t.Fatalf("openexit %s failed: %v", strings.Join(args, " "), err)
+		}
+	}
+
+	out, err := executeForTestWithOutput("status", "--project", projectDir)
+	if err != nil {
+		t.Fatalf("openexit status failed: %v", err)
+	}
+	for _, marker := range []string{
+		"source: datadog",
+		"target: grafana-lgtm",
+		"layout: ok",
+		"inventory: present",
+		"assessment: present",
+		"mapping: present",
+		"generated: present",
+		"validation: passed",
+		"export-ready: yes",
+		"next: openexit export",
+	} {
+		if !strings.Contains(out, marker) {
+			t.Fatalf("expected status marker %q, got:\n%s", marker, out)
+		}
+	}
+
+	jsonOut, err := executeForTestWithOutput("status", "--project", projectDir, "--json")
+	if err != nil {
+		t.Fatalf("openexit status --json failed: %v", err)
+	}
+	var status ProjectStatus
+	if err := json.Unmarshal([]byte(jsonOut), &status); err != nil {
+		t.Fatalf("decode status JSON: %v\n%s", err, jsonOut)
+	}
+	if !status.ReadyForExport || status.Validation.Status != "passed" {
+		t.Fatalf("expected export-ready passed status, got %+v", status)
+	}
+	if status.Inventory.Assets["dashboards"] != 1 || status.Generated.Candidates == 0 || len(status.NextActions) != 1 {
+		t.Fatalf("unexpected status summary: %+v", status)
+	}
+}
+
 func TestCLICommandFailuresAreActionable(t *testing.T) {
 	projectDir := filepath.Join(t.TempDir(), "demo")
 	if err := executeForTest("init", projectDir); err != nil {
@@ -911,6 +967,16 @@ func executeForTest(args ...string) error {
 	return cmd.Execute()
 }
 
+func executeForTestWithOutput(args ...string) (string, error) {
+	cmd := NewRootCommand()
+	var out bytes.Buffer
+	cmd.SetArgs(args)
+	cmd.SetOut(&out)
+	cmd.SetErr(io.Discard)
+	err := cmd.Execute()
+	return out.String(), err
+}
+
 func expectedProjectFiles() []string {
 	return []string{
 		"openexit.yaml",