Merge pull request #3 from managedcode/codex/standardize-project-naming-and-improve-readme

KSemenenko · web-flow · commit 625f8d62be85 · 2026-01-03T18:22:43.000+01:00
Fix .NET 10 test runner and finalize `ragsharp-graph` rename / storage path changes
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,7 @@ bin/
 obj/
 .vs/
 .idea/
-.codegraph/
+.ragsharp/graph/
 dist/
 artifacts/
 TestResults/
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -0,0 +1,8 @@
+<Project>
+  <Target Name="_MTPBeforeVSTest" BeforeTargets="VSTest">
+    <PropertyGroup>
+      <_SupportsGlobalJsonTestRunner>false</_SupportsGlobalJsonTestRunner>
+    </PropertyGroup>
+    <CallTarget Condition="'$(VSTestNoBuild)' != 'true' AND '$(TargetFramework)' != ''" Targets="BuildProject" />
+  </Target>
+</Project>
diff --git a/README.md b/README.md
@@ -1,12 +1,24 @@
 # RagSharp
 
-RagSharp provides a deterministic, offline-capable code graph indexer and skill installer for C#/.NET repositories. It ships a single NuGet package containing:
+RagSharp is a deterministic, offline-capable toolkit for indexing and querying C#/.NET repositories.
+It ships as a single NuGet package that provides two command-line tools:
 
-- `ragsharp` — installer for Codex skills.
-- `ragsharp-codegraph` — code graph indexer/query CLI.
+- `ragsharp` — installs/uninstalls Codex skills into a repository.
+- `ragsharp-graph` — builds and queries a code graph index for fast, structured lookups.
 
 See the Codex skill specification at https://agentskills.io/specification.
 
+## What RagSharp does
+
+RagSharp focuses on repeatable, offline analysis of C# codebases:
+
+- **Indexes** source code and builds a graph of types, members, usings, and relationships.
+- **Queries** the graph (symbols, inheritance, references) and outputs JSON for automation.
+- **Installs skills** that wrap common workflows such as indexing or querying.
+
+All outputs are stored under `.ragsharp/graph/` by default to keep artifacts organized and
+easy to clean up.
+
 ## Requirements
 
 - .NET SDK 10 (only target).
@@ -26,7 +38,7 @@ dotnet --list-sdks
 ```bash
 dotnet build
 
-dotnet test
+dotnet test ragsharp.slnx
 ```
 
 ## Package
@@ -45,21 +57,53 @@ dotnet add package RagSharp --source /path/to/ragsharp/dist
 ragsharp install --root . --skill-dir .codex/skills
 ```
 
-## Index and query
+## RagSharp Graph quickstart
+
+Build and query the graph:
 
 ```bash
-ragsharp-codegraph doctor --root .
+ragsharp-graph doctor --root .
 
-ragsharp-codegraph index --root . --db .codegraph/index.db --state .codegraph/state.json
+ragsharp-graph index --root . --db .ragsharp/graph/index.db --state .ragsharp/graph/state.json
 
-ragsharp-codegraph query symbols --db .codegraph/index.db --format json --limit 50 --symbol "Greeter"
+ragsharp-graph query symbols --db .ragsharp/graph/index.db --format json --limit 50 --symbol "Greeter"
+```
+
+Export the graph:
+
+```bash
+ragsharp-graph export --db .ragsharp/graph/index.db --format dot --out .ragsharp/graph/graph.dot
 ```
 
+## CLI reference
+
+### `ragsharp`
+
+- `ragsharp install --root <path> --skill-dir <path>` — install skills.
+- `ragsharp uninstall --root <path> --skill-dir <path>` — uninstall skills.
+
+### `ragsharp-graph`
+
+- `doctor` — verify the environment and print the repository root.
+- `index` — build a fresh index.
+- `update` — incrementally update the index and remove deleted files.
+- `query <type>` — query the index (`symbols`, `usings`, etc.) and emit JSON.
+- `export` — export the graph as `dot` or `gexf`.
+
 ## Output locations
 
 - `.codex/skills/` contains installed skills.
-- `.codegraph/` contains the index and state files (not committed).
-- Ensure `.codegraph/` and `state.json` remain in `.gitignore`.
+- `.ragsharp/graph/` contains the index and state files (not committed).
+- Ensure `.ragsharp/graph/` and `state.json` remain in `.gitignore`.
+
+## Example prompts
+
+Use these with your assistant after indexing:
+
+- “List the top 20 symbols that inherit from `BaseType` in JSON.”
+- “Show usages of `HttpClient` and include 3 context lines.”
+- “Find all public methods in `src/` that return `Task`.”
+- “Export the graph to DOT and summarize the top 10 node kinds.”
 
 ## Troubleshooting
 
diff --git a/assets/skill-templates/build-code-graph/SKILL.md b/assets/skill-templates/build-code-graph/SKILL.md
@@ -1,15 +1,15 @@
 ---
 name: ragsharp-build-code-graph
 description: |
-  Build or update a code graph index for C#/.NET repositories using ragsharp-codegraph.
+  Build or update a code graph index for C#/.NET repositories using ragsharp-graph.
   Triggers: build index, update index, refresh index, code graph, dependency graph, static analysis, Roslyn, line numbers.
 ---
 ## Steps
-1. Run `ragsharp-codegraph doctor --root .`.
-2. Run `ragsharp-codegraph index --root . --db .codegraph/index.db --state .codegraph/state.json`.
-3. For incremental updates, run `ragsharp-codegraph update --root . --db .codegraph/index.db --state .codegraph/state.json`.
+1. Run `ragsharp-graph doctor --root .`.
+2. Run `ragsharp-graph index --root . --db .ragsharp/graph/index.db --state .ragsharp/graph/state.json`.
+3. For incremental updates, run `ragsharp-graph update --root . --db .ragsharp/graph/index.db --state .ragsharp/graph/state.json`.
 
 ## Expected Results
-- `.codegraph/index.db` exists.
-- `.codegraph/state.json` is updated.
+- `.ragsharp/graph/index.db` exists.
+- `.ragsharp/graph/state.json` is updated.
 - Output goes to stderr, JSON is emitted only for query commands.
diff --git a/assets/skill-templates/build-code-graph/references/README.md b/assets/skill-templates/build-code-graph/references/README.md
@@ -1,6 +1,6 @@
 # Build Code Graph Skill
 
 Use this skill to initialize or refresh the code graph index.
-- `ragsharp-codegraph doctor` validates tooling.
-- `ragsharp-codegraph index` builds the graph.
-- `ragsharp-codegraph update` applies incremental changes.
+- `ragsharp-graph doctor` validates tooling.
+- `ragsharp-graph index` builds the graph.
+- `ragsharp-graph update` applies incremental changes.
diff --git a/assets/skill-templates/build-code-graph/scripts/run.ps1 b/assets/skill-templates/build-code-graph/scripts/run.ps1
@@ -1,2 +1,2 @@
 param([string]$Root = ".")
-ragsharp-codegraph index --root $Root --db .codegraph/index.db --state .codegraph/state.json
+ragsharp-graph index --root $Root --db .ragsharp/graph/index.db --state .ragsharp/graph/state.json
diff --git a/assets/skill-templates/build-code-graph/scripts/run.sh b/assets/skill-templates/build-code-graph/scripts/run.sh
@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 set -euo pipefail
-ragsharp-codegraph index --root "${1:-.}" --db .codegraph/index.db --state .codegraph/state.json
+ragsharp-graph index --root "${1:-.}" --db .ragsharp/graph/index.db --state .ragsharp/graph/state.json
diff --git a/assets/skill-templates/query-code-graph/SKILL.md b/assets/skill-templates/query-code-graph/SKILL.md
@@ -5,5 +5,5 @@ description: |
   Triggers: find usages, where defined, callers, callees, dependency path, project deps, type hierarchy, line numbers, evidence.
 ---
 ## Steps
-1. Run `ragsharp-codegraph query symbols --db .codegraph/index.db --format json --limit 50 --symbol "SymbolName"`.
+1. Run `ragsharp-graph query symbols --db .ragsharp/graph/index.db --format json --limit 50 --symbol "SymbolName"`.
 2. Use the JSON output to answer questions with file:line-range evidence.
diff --git a/assets/skill-templates/query-code-graph/scripts/run.ps1 b/assets/skill-templates/query-code-graph/scripts/run.ps1
@@ -1,2 +1,2 @@
 param([string]$Symbol = "")
-ragsharp-codegraph query symbols --db .codegraph/index.db --format json --limit 50 --symbol $Symbol
+ragsharp-graph query symbols --db .ragsharp/graph/index.db --format json --limit 50 --symbol $Symbol
diff --git a/assets/skill-templates/query-code-graph/scripts/run.sh b/assets/skill-templates/query-code-graph/scripts/run.sh
@@ -1,3 +1,3 @@
 #!/usr/bin/env bash
 set -euo pipefail
-ragsharp-codegraph query symbols --db .codegraph/index.db --format json --limit 50 --symbol "${1:-}" 
+ragsharp-graph query symbols --db .ragsharp/graph/index.db --format json --limit 50 --symbol "${1:-}" 
diff --git a/docs/Development/CodeGraph.md b/docs/Development/CodeGraph.md
@@ -1,14 +1,18 @@
-# Code Graph CLI
+# RagSharp Graph CLI
 
 ## Commands
 
-- `ragsharp-codegraph doctor --root <path>`
-- `ragsharp-codegraph index --root <path> --db .codegraph/index.db --state .codegraph/state.json`
-- `ragsharp-codegraph update --root <path> --db .codegraph/index.db --state .codegraph/state.json`
-- `ragsharp-codegraph query <queryType> --db .codegraph/index.db --format json --limit N --context-lines M`
-- `ragsharp-codegraph export --db .codegraph/index.db --format dot|gexf --out .codegraph/graph.dot`
+- `ragsharp-graph doctor --root <path>`
+- `ragsharp-graph index --root <path> --db .ragsharp/graph/index.db --state .ragsharp/graph/state.json`
+- `ragsharp-graph update --root <path> --db .ragsharp/graph/index.db --state .ragsharp/graph/state.json`
+- `ragsharp-graph query <queryType> --db .ragsharp/graph/index.db --format json --limit N --context-lines M`
+- `ragsharp-graph export --db .ragsharp/graph/index.db --format dot|gexf --out .ragsharp/graph/graph.dot`
 
-## Files\n\n- `.codegraph/index.db` — SQLite graph database.\n- `.codegraph/state.json` — incremental index state.\n- `.codegraph/schema_version` — schema version guard.\n+
+## Files
+
+- `.ragsharp/graph/index.db` — SQLite graph database.
+- `.ragsharp/graph/state.json` — incremental index state.
+- `.ragsharp/graph/schema_version` — schema version guard.
 ## Exit codes
 
 - 0: success
diff --git a/docs/Development/Performance.md b/docs/Development/Performance.md
@@ -1,5 +1,5 @@
 # Performance
 
-- Use `ragsharp-codegraph update` for incremental indexing.
+- Use `ragsharp-graph update` for incremental indexing.
 - Store the database on fast local storage.
 - Increase `--limit` cautiously for large repositories.
diff --git a/docs/Development/QueryContract.md b/docs/Development/QueryContract.md
@@ -1,6 +1,6 @@
 # Query Contract
 
-All `ragsharp-codegraph query` commands emit JSON to stdout. Logs go to stderr. The JSON schema is defined in [OutputSchema.md](OutputSchema.md).
+All `ragsharp-graph query` commands emit JSON to stdout. Logs go to stderr. The JSON schema is defined in [OutputSchema.md](OutputSchema.md).
 
 Query requests support:
 - `--symbol` to filter by name or fully-qualified name.
diff --git a/docs/Development/Troubleshooting.md b/docs/Development/Troubleshooting.md
@@ -1,5 +1,5 @@
 # Troubleshooting
 
 - Ensure .NET SDK 10 is installed and on PATH.
-- Run `ragsharp-codegraph doctor` for environment checks.
-- Delete `.codegraph/` to rebuild the index from scratch.
+- Run `ragsharp-graph doctor` for environment checks.
+- Delete `.ragsharp/graph/` to rebuild the index from scratch.
diff --git a/global.json b/global.json
@@ -2,7 +2,7 @@
   "sdk": {
     "version": "10.0.100",
     "rollForward": "latestFeature",
-    "allowPrerelease": true,
-    "testRunner": "Microsoft.Testing.Platform"
-  }
+    "allowPrerelease": true
+  },
+  "testRunner": "Microsoft.Testing.Platform"
 }
diff --git a/src/RagSharp.CodeGraph.Cli/Program.cs b/src/RagSharp.CodeGraph.Cli/Program.cs
@@ -16,7 +16,7 @@ public static async Task<int> Main(string[] args)
     {
         if (args.Length == 0)
         {
-            Console.Error.WriteLine("ragsharp-codegraph <command> [options]");
+            Console.Error.WriteLine("ragsharp-graph <command> [options]");
             return ExitInvalidArgs;
         }
 
@@ -63,8 +63,8 @@ private static Task<int> RunDoctorAsync(Dictionary<string, string?> options)
     private static async Task<int> RunIndexAsync(Dictionary<string, string?> options, bool isUpdate)
     {
         var root = options.GetValueOrDefault("--root") ?? Directory.GetCurrentDirectory();
-        var dbPath = options.GetValueOrDefault("--db") ?? Path.Combine(root, ".codegraph", "index.db");
-        var statePath = options.GetValueOrDefault("--state") ?? Path.Combine(root, ".codegraph", "state.json");
+        var dbPath = options.GetValueOrDefault("--db") ?? Path.Combine(root, ".ragsharp", "graph", "index.db");
+        var statePath = options.GetValueOrDefault("--state") ?? Path.Combine(root, ".ragsharp", "graph", "state.json");
         var includeDataflow = options.ContainsKey("--include-dataflow");
 
         var store = new LiteGraphStore(dbPath);
@@ -99,7 +99,7 @@ private static async Task<int> RunQueryAsync(string[] args)
 
         var queryType = args[0];
         var options = ParseOptions(args.Skip(1).ToArray());
-        var dbPath = options.GetValueOrDefault("--db") ?? Path.Combine(Directory.GetCurrentDirectory(), ".codegraph", "index.db");
+        var dbPath = options.GetValueOrDefault("--db") ?? Path.Combine(Directory.GetCurrentDirectory(), ".ragsharp", "graph", "index.db");
         if (!File.Exists(dbPath))
         {
             throw new FileNotFoundException("Index database not found.");
@@ -130,9 +130,9 @@ private static async Task<int> RunQueryAsync(string[] args)
 
     private static async Task<int> RunExportAsync(Dictionary<string, string?> options)
     {
-        var dbPath = options.GetValueOrDefault("--db") ?? Path.Combine(Directory.GetCurrentDirectory(), ".codegraph", "index.db");
+        var dbPath = options.GetValueOrDefault("--db") ?? Path.Combine(Directory.GetCurrentDirectory(), ".ragsharp", "graph", "index.db");
         var format = options.GetValueOrDefault("--format") ?? "dot";
-        var output = options.GetValueOrDefault("--out") ?? Path.Combine(Directory.GetCurrentDirectory(), ".codegraph", "graph.dot");
+        var output = options.GetValueOrDefault("--out") ?? Path.Combine(Directory.GetCurrentDirectory(), ".ragsharp", "graph", "graph.dot");
 
         var store = new LiteGraphStore(dbPath);
         await store.InitializeAsync(CancellationToken.None).ConfigureAwait(false);
@@ -154,7 +154,7 @@ private static async Task<int> RunExportAsync(Dictionary<string, string?> option
 
     private static void WriteSchemaVersionFile(string root)
     {
-        var schemaPath = Path.Combine(root, ".codegraph", "schema_version");
+        var schemaPath = Path.Combine(root, ".ragsharp", "graph", "schema_version");
         Directory.CreateDirectory(Path.GetDirectoryName(schemaPath) ?? ".");
         File.WriteAllText(schemaPath, SchemaConstants.CurrentVersion);
     }
diff --git a/src/RagSharp.CodeGraph.Cli/RagSharp.CodeGraph.Cli.csproj b/src/RagSharp.CodeGraph.Cli/RagSharp.CodeGraph.Cli.csproj
@@ -4,7 +4,7 @@
     <TargetFramework>net10.0</TargetFramework>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
-    <AssemblyName>ragsharp-codegraph</AssemblyName>
+    <AssemblyName>ragsharp-graph</AssemblyName>
     <RootNamespace>RagSharp.CodeGraph.Cli</RootNamespace>
   </PropertyGroup>
   <ItemGroup>
diff --git a/src/RagSharp.Packaging/RagSharp.Packaging.csproj b/src/RagSharp.Packaging/RagSharp.Packaging.csproj
@@ -5,6 +5,7 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <IsPackable>true</IsPackable>
     <PackageId>RagSharp</PackageId>
+    <ProjectName>RagSharp.Packaging</ProjectName>
     <Version>0.1.0</Version>
     <Authors>RagSharp</Authors>
     <Description>RagSharp code graph skills installer and CLI tools.</Description>
@@ -18,7 +19,7 @@
     <ProjectReference Include="../RagSharp.SkillInstaller/RagSharp.SkillInstaller.csproj" PrivateAssets="all" />
   </ItemGroup>
   <ItemGroup>
-    <None Include="../RagSharp.CodeGraph.Cli/bin/$(Configuration)/net10.0/**" Pack="true" PackagePath="tools/net10.0/any/ragsharp-codegraph" />
+    <None Include="../RagSharp.CodeGraph.Cli/bin/$(Configuration)/net10.0/**" Pack="true" PackagePath="tools/net10.0/any/ragsharp-graph" />
     <None Include="../RagSharp.SkillInstaller/bin/$(Configuration)/net10.0/**" Pack="true" PackagePath="tools/net10.0/any/ragsharp" />
   </ItemGroup>
 </Project>
diff --git a/src/RagSharp.SkillInstaller/RagSharp.SkillInstaller.csproj b/src/RagSharp.SkillInstaller/RagSharp.SkillInstaller.csproj
@@ -5,6 +5,8 @@
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
     <AssemblyName>ragsharp</AssemblyName>
+    <IsPackable>false</IsPackable>
+    <PackageId>RagSharp.SkillInstaller</PackageId>
     <RootNamespace>RagSharp.SkillInstaller</RootNamespace>
   </PropertyGroup>
   <ItemGroup>
diff --git a/tests/RagSharp.CodeGraph.Tests/CodeGraphIntegrationTests.cs b/tests/RagSharp.CodeGraph.Tests/CodeGraphIntegrationTests.cs
@@ -115,7 +115,7 @@ private IndexTestContext(string rootPath, LiteGraphStore store, IndexResult resu
 
     public static async Task<IndexTestContext> CreateAsync()
     {
-        var root = Path.Combine(Path.GetTempPath(), $"ragsharp-codegraph-{Guid.NewGuid():N}");
+        var root = Path.Combine(Path.GetTempPath(), $"ragsharp-graph-{Guid.NewGuid():N}");
         Directory.CreateDirectory(root);
 
         var projectDir = Path.Combine(root, "GeneratedProject");
@@ -176,7 +176,7 @@ public sealed class {{name}}
         var indexer = new CodeGraphIndexer(includeDataflow: false);
         var result = await indexer.IndexAsync(projectDir, CancellationToken.None);
 
-        var dbPath = Path.Combine(projectDir, ".codegraph", "index.db");
+        var dbPath = Path.Combine(projectDir, ".ragsharp", "graph", "index.db");
         var store = new LiteGraphStore(dbPath);
         await store.InitializeAsync(CancellationToken.None);
         await store.SaveIndexAsync(result, CancellationToken.None);
diff --git a/tests/RagSharp.CodeGraph.Tests/RagSharp.CodeGraph.Tests.csproj b/tests/RagSharp.CodeGraph.Tests/RagSharp.CodeGraph.Tests.csproj
@@ -5,6 +5,9 @@
     <IsPackable>false</IsPackable>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
+    <EnableTestingPlatform>true</EnableTestingPlatform>
+    <TestingPlatformDotnetTestSupport>true</TestingPlatformDotnetTestSupport>
+    <UseMSBuildTestInfrastructure>true</UseMSBuildTestInfrastructure>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="TUnit" Version="1.8.1" />
diff --git a/tests/RagSharp.SkillInstaller.Tests/RagSharp.SkillInstaller.Tests.csproj b/tests/RagSharp.SkillInstaller.Tests/RagSharp.SkillInstaller.Tests.csproj
@@ -5,6 +5,9 @@
     <IsPackable>false</IsPackable>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
+    <EnableTestingPlatform>true</EnableTestingPlatform>
+    <TestingPlatformDotnetTestSupport>true</TestingPlatformDotnetTestSupport>
+    <UseMSBuildTestInfrastructure>true</UseMSBuildTestInfrastructure>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="TUnit" Version="1.8.1" />

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`param([string]$Root = ".")`
`2`		`-ragsharp-codegraph index --root $Root --db .codegraph/index.db --state .codegraph/state.json`
	`2`	`+ragsharp-graph index --root $Root --db .ragsharp/graph/index.db --state .ragsharp/graph/state.json`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`param([string]$Symbol = "")`
`2`		`-ragsharp-codegraph query symbols --db .codegraph/index.db --format json --limit 50 --symbol $Symbol`
	`2`	`+ragsharp-graph query symbols --db .ragsharp/graph/index.db --format json --limit 50 --symbol $Symbol`