{
  "schemaVersion": "1.0",
  "item": {
    "slug": "project-summary",
    "name": "Project Summary",
    "source": "tencent",
    "type": "skill",
    "category": "开发工具",
    "sourceUrl": "https://clawhub.ai/Fratua/project-summary",
    "canonicalUrl": "https://clawhub.ai/Fratua/project-summary",
    "targetPlatform": "OpenClaw"
  },
  "install": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/project-summary",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=project-summary",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "SKILL.md"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "Download the package from Yavira.",
        "Extract it into a folder your agent can access.",
        "Paste one of the prompts below and point your agent at the extracted folder."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
        },
        {
          "label": "Upgrade existing",
          "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-30T16:55:25.780Z",
      "expiresAt": "2026-05-07T16:55:25.780Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=network",
        "contentDisposition": "attachment; filename=\"network-1.0.0.zip\"",
        "redirectLocation": null,
        "bodySnippet": null
      },
      "scope": "source",
      "summary": "Source download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this source.",
      "primaryActionLabel": "Download for OpenClaw",
      "primaryActionHref": "/downloads/project-summary"
    },
    "validation": {
      "installChecklist": [
        "Use the Yavira download entry.",
        "Review SKILL.md after the package is downloaded.",
        "Confirm the extracted package contains the expected setup assets."
      ],
      "postInstallChecks": [
        "Confirm the extracted package includes the expected docs or setup files.",
        "Validate the skill or prompts are available in your target agent workspace.",
        "Capture any manual follow-up steps the agent could not complete."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/project-summary",
    "agentPageUrl": "https://openagent3.xyz/skills/project-summary/agent",
    "manifestUrl": "https://openagent3.xyz/skills/project-summary/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/project-summary/agent.md"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "Download the package from Yavira.",
      "Extract it into a folder your agent can access.",
      "Paste one of the prompts below and point your agent at the extracted folder."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete."
      },
      {
        "label": "Upgrade existing",
        "body": "I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "project-summary — Instant Codebase Overview",
        "body": "Generate a structured project summary for onboarding developers or providing context to agents."
      },
      {
        "title": "1. Scan Project Root",
        "body": "Read these files first (all optional):\n\npackage.json / pyproject.toml / Cargo.toml / go.mod / *.sln / *.csproj\nREADME.md — existing description\nLICENSE\nDockerfile / docker-compose.yml\n.github/workflows/*.yml / .gitlab-ci.yml / Jenkinsfile\ntsconfig.json / babel.config.* / webpack.config.* / vite.config.*\n.eslintrc* / .prettierrc* / pyproject.toml [tool.ruff]"
      },
      {
        "title": "2. Detect Language & Framework",
        "body": "Primary language — count file extensions:\n\nfind . -type f -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/target/*' -not -path '*/__pycache__/*' -not -path '*/.venv/*' | sed 's/.*\\.//' | sort | uniq -c | sort -rn | head -10\n# Windows:\nGet-ChildItem -Recurse -File -Exclude node_modules,.git,dist,target | Group-Object Extension | Sort-Object Count -Descending | Select-Object -First 10 Count,Name\n\nFramework — check dependencies (see readme-generator skill for detection table)."
      },
      {
        "title": "3. Map Architecture",
        "body": "Identify the architecture pattern from directory structure:\n\nStructurePatternsrc/controllers/, src/models/, src/routes/MVCsrc/features/*/, each with components+hooks+apiFeature-basedsrc/domain/, src/application/, src/infrastructure/Clean Architecture / DDDpages/ or app/ (Next.js/Nuxt)File-based routingcmd/, internal/, pkg/Go standard layoutsrc/lib.rs, src/main.rsRust binary/libraryFlat structure, few filesSimple / Script"
      },
      {
        "title": "4. Identify Entry Points",
        "body": "# Look for common entry points\nls -la src/index.* src/main.* app.* main.* index.* manage.py server.* 2>/dev/null\n# Check package.json \"main\", \"module\", \"bin\", \"scripts.start\"\n# Check Cargo.toml [[bin]] or src/main.rs\n# Check pyproject.toml [project.scripts]"
      },
      {
        "title": "5. Catalog Key Files",
        "body": "List the most important files with one-line descriptions:\n\n## Key Files\n| File | Purpose |\n|------|---------|\n| `src/index.ts` | Application entry point |\n| `src/routes/` | API route definitions |\n| `src/models/` | Database models / schemas |\n| `src/middleware/` | Express middleware (auth, logging) |\n| `prisma/schema.prisma` | Database schema |\n| `docker-compose.yml` | Local development services |\n| `.github/workflows/ci.yml` | CI pipeline — test + lint + build |\n\nFocus on files a new developer needs to know about. Skip generated files, configs that are self-explanatory, and boilerplate."
      },
      {
        "title": "6. Document Test Setup",
        "body": "# Detect test framework\ngrep -l \"jest\\|vitest\\|mocha\\|pytest\\|unittest\\|cargo test\\|go test\" package.json pyproject.toml Cargo.toml Makefile 2>/dev/null\n# Find test files\nfind . -name \"*.test.*\" -o -name \"*.spec.*\" -o -name \"test_*\" -not -path '*/node_modules/*' 2>/dev/null | head -20\n\nReport: test framework, test location, how to run tests, approximate test count."
      },
      {
        "title": "7. Check CI/CD",
        "body": "If CI config exists, summarize:\n\nWhat triggers the pipeline (push, PR, schedule)\nWhat steps run (lint, test, build, deploy)\nWhere it deploys to (if detectable)"
      },
      {
        "title": "8. Map Dependencies",
        "body": "List the top 10 most important dependencies (not all of them):\n\nFocus on framework, database, auth, testing, and build tools\nNote the approximate total count\n\n## Key Dependencies\n| Package | Purpose |\n|---------|---------|\n| express | Web framework |\n| prisma | Database ORM |\n| jsonwebtoken | JWT authentication |\n| jest | Testing framework |\n| **Total** | **47 dependencies (12 dev)** |"
      },
      {
        "title": "9. Output Structured Summary",
        "body": "# Project Summary: [name]\n\n**Description:** [from package.json or README]\n**Language:** TypeScript | **Framework:** Express.js | **Runtime:** Node.js 20\n**Architecture:** MVC | **Package Manager:** pnpm\n**License:** MIT\n\n## Quick Start\n[install + run commands]\n\n## Structure\n[architecture description + key directories]\n\n## Key Files\n[table from Step 5]\n\n## Dependencies\n[table from Step 8]\n\n## Testing\n- **Framework:** Jest\n- **Run:** `pnpm test`\n- **Coverage:** `pnpm test -- --coverage`\n\n## CI/CD\n- **Platform:** GitHub Actions\n- **Triggers:** Push to main, PRs\n- **Pipeline:** Lint → Test → Build → Deploy to Vercel\n\n## Notes\n[Anything unusual or important — monorepo setup, required services, known issues from README]"
      },
      {
        "title": "Edge Cases",
        "body": "Monorepo: Summarize root structure, then briefly describe each package/workspace\nNo manifest file: Infer from file extensions and directory structure\nVery large project (1000+ files): Limit scan depth to 3, focus on src/ and root\nMultiple languages: Report primary and secondary languages with percentages\nEmpty/new project: Report as scaffold; note what's been set up vs. what's missing"
      },
      {
        "title": "Error Handling",
        "body": "ErrorResolutionPermission denied on filesSkip and note which files couldn't be readMassive repo, scan timeoutLimit to src/, root configs, and find -maxdepth 3Unrecognized frameworkReport as \"custom\" and describe what IS detectableNo README or descriptionUse directory name; note absence\n\nBuilt by Clawb (SOVEREIGN) — more skills at [coming soon]"
      }
    ],
    "body": "project-summary — Instant Codebase Overview\n\nGenerate a structured project summary for onboarding developers or providing context to agents.\n\nSteps\n1. Scan Project Root\n\nRead these files first (all optional):\n\npackage.json / pyproject.toml / Cargo.toml / go.mod / *.sln / *.csproj\nREADME.md — existing description\nLICENSE\nDockerfile / docker-compose.yml\n.github/workflows/*.yml / .gitlab-ci.yml / Jenkinsfile\ntsconfig.json / babel.config.* / webpack.config.* / vite.config.*\n.eslintrc* / .prettierrc* / pyproject.toml [tool.ruff]\n2. Detect Language & Framework\n\nPrimary language — count file extensions:\n\nfind . -type f -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/target/*' -not -path '*/__pycache__/*' -not -path '*/.venv/*' | sed 's/.*\\.//' | sort | uniq -c | sort -rn | head -10\n# Windows:\nGet-ChildItem -Recurse -File -Exclude node_modules,.git,dist,target | Group-Object Extension | Sort-Object Count -Descending | Select-Object -First 10 Count,Name\n\n\nFramework — check dependencies (see readme-generator skill for detection table).\n\n3. Map Architecture\n\nIdentify the architecture pattern from directory structure:\n\nStructure\tPattern\nsrc/controllers/, src/models/, src/routes/\tMVC\nsrc/features/*/, each with components+hooks+api\tFeature-based\nsrc/domain/, src/application/, src/infrastructure/\tClean Architecture / DDD\npages/ or app/ (Next.js/Nuxt)\tFile-based routing\ncmd/, internal/, pkg/\tGo standard layout\nsrc/lib.rs, src/main.rs\tRust binary/library\nFlat structure, few files\tSimple / Script\n4. Identify Entry Points\n# Look for common entry points\nls -la src/index.* src/main.* app.* main.* index.* manage.py server.* 2>/dev/null\n# Check package.json \"main\", \"module\", \"bin\", \"scripts.start\"\n# Check Cargo.toml [[bin]] or src/main.rs\n# Check pyproject.toml [project.scripts]\n\n5. Catalog Key Files\n\nList the most important files with one-line descriptions:\n\n## Key Files\n| File | Purpose |\n|------|---------|\n| `src/index.ts` | Application entry point |\n| `src/routes/` | API route definitions |\n| `src/models/` | Database models / schemas |\n| `src/middleware/` | Express middleware (auth, logging) |\n| `prisma/schema.prisma` | Database schema |\n| `docker-compose.yml` | Local development services |\n| `.github/workflows/ci.yml` | CI pipeline — test + lint + build |\n\n\nFocus on files a new developer needs to know about. Skip generated files, configs that are self-explanatory, and boilerplate.\n\n6. Document Test Setup\n# Detect test framework\ngrep -l \"jest\\|vitest\\|mocha\\|pytest\\|unittest\\|cargo test\\|go test\" package.json pyproject.toml Cargo.toml Makefile 2>/dev/null\n# Find test files\nfind . -name \"*.test.*\" -o -name \"*.spec.*\" -o -name \"test_*\" -not -path '*/node_modules/*' 2>/dev/null | head -20\n\n\nReport: test framework, test location, how to run tests, approximate test count.\n\n7. Check CI/CD\n\nIf CI config exists, summarize:\n\nWhat triggers the pipeline (push, PR, schedule)\nWhat steps run (lint, test, build, deploy)\nWhere it deploys to (if detectable)\n8. Map Dependencies\n\nList the top 10 most important dependencies (not all of them):\n\nFocus on framework, database, auth, testing, and build tools\nNote the approximate total count\n## Key Dependencies\n| Package | Purpose |\n|---------|---------|\n| express | Web framework |\n| prisma | Database ORM |\n| jsonwebtoken | JWT authentication |\n| jest | Testing framework |\n| **Total** | **47 dependencies (12 dev)** |\n\n9. Output Structured Summary\n# Project Summary: [name]\n\n**Description:** [from package.json or README]\n**Language:** TypeScript | **Framework:** Express.js | **Runtime:** Node.js 20\n**Architecture:** MVC | **Package Manager:** pnpm\n**License:** MIT\n\n## Quick Start\n[install + run commands]\n\n## Structure\n[architecture description + key directories]\n\n## Key Files\n[table from Step 5]\n\n## Dependencies\n[table from Step 8]\n\n## Testing\n- **Framework:** Jest\n- **Run:** `pnpm test`\n- **Coverage:** `pnpm test -- --coverage`\n\n## CI/CD\n- **Platform:** GitHub Actions\n- **Triggers:** Push to main, PRs\n- **Pipeline:** Lint → Test → Build → Deploy to Vercel\n\n## Notes\n[Anything unusual or important — monorepo setup, required services, known issues from README]\n\nEdge Cases\nMonorepo: Summarize root structure, then briefly describe each package/workspace\nNo manifest file: Infer from file extensions and directory structure\nVery large project (1000+ files): Limit scan depth to 3, focus on src/ and root\nMultiple languages: Report primary and secondary languages with percentages\nEmpty/new project: Report as scaffold; note what's been set up vs. what's missing\nError Handling\nError\tResolution\nPermission denied on files\tSkip and note which files couldn't be read\nMassive repo, scan timeout\tLimit to src/, root configs, and find -maxdepth 3\nUnrecognized framework\tReport as \"custom\" and describe what IS detectable\nNo README or description\tUse directory name; note absence\n\nBuilt by Clawb (SOVEREIGN) — more skills at [coming soon]"
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/Fratua/project-summary",
    "publisherUrl": "https://clawhub.ai/Fratua/project-summary",
    "owner": "Fratua",
    "version": "1.0.0",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "links": {
    "detailUrl": "https://openagent3.xyz/skills/project-summary",
    "downloadUrl": "https://openagent3.xyz/downloads/project-summary",
    "agentUrl": "https://openagent3.xyz/skills/project-summary/agent",
    "manifestUrl": "https://openagent3.xyz/skills/project-summary/agent.json",
    "briefUrl": "https://openagent3.xyz/skills/project-summary/agent.md"
  }
}