@aigne/example-afs-git 1.1.0 → 1.74.0-beta

package/README.md

@@ -2,13 +2,13 @@
 
 <p align="center">
   <picture>
-    <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo-dark.svg" media="(prefers-color-scheme: dark)">
-    <source srcset="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo.svg" media="(prefers-color-scheme: light)">
-    <img src="https://raw.githubusercontent.com/AIGNE-io/aigne-framework/main/logo.svg" alt="AIGNE Logo" width="400" />
+    <source srcset="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/logo-dark.svg" media="(prefers-color-scheme: dark)">
+    <source srcset="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/logo.svg" media="(prefers-color-scheme: light)">
+    <img src="https://raw.githubusercontent.com/ArcBlock/aigne-framework/main/logo.svg" alt="AIGNE Logo" width="400" />
   </picture>
 </p>
 
-This example demonstrates how to create a chatbot that can interact with Git repositories using the [AIGNE Framework](https://github.com/AIGNE-io/aigne-framework) and [AIGNE CLI](https://github.com/AIGNE-io/aigne-framework/blob/main/packages/cli/README.md). The example utilizes the `AFSGit` module to provide Git repository access to AI agents through the **AIGNE File System (AFS)** interface.
+This example demonstrates how to create a chatbot that can interact with Git repositories using the [AIGNE Framework](https://github.com/ArcBlock/aigne-framework) and [AIGNE CLI](https://github.com/ArcBlock/aigne-framework/blob/main/packages/cli/README.md). The example utilizes the `AFSGit` module to provide Git repository access to AI agents through the **AIGNE File System (AFS)** interface.
 
 **AIGNE File System (AFS)** is a virtual file system abstraction that provides AI agents with unified access to various storage backends. For comprehensive documentation, see [AFS Documentation](../../afs/README.md).
 
@@ -43,9 +43,12 @@ export OPENAI_API_KEY=YOUR_OPENAI_API_KEY
 # Mount current Git repository (read-only by default)
 npx -y @aigne/example-afs-git --interactive
 
-# Mount a specific repository
+# Mount a specific local repository
 npx -y @aigne/example-afs-git --path /path/to/repo --interactive
 
+# Mount a remote Git repository
+npx -y @aigne/example-afs-git --url https://github.com/user/repo.git --interactive
+
 # Ask a specific question
 npx -y @aigne/example-afs-git --input "What files changed in the last commit on main?"
 
@@ -122,7 +125,7 @@ The `aigne observe` command starts a local web server to monitor and analyze age
 ### Clone the Repository
 
 ```bash
-git clone https://github.com/AIGNE-io/aigne-framework
+git clone https://github.com/ArcBlock/aigne-framework
 ```
 
 ### Install Dependencies
@@ -139,9 +142,12 @@ pnpm install
 # Run with current repository (read-only by default)
 pnpm start
 
-# Run with a specific repository
+# Run with a specific local repository
 pnpm start --path /path/to/repo
 
+# Run with a remote repository
+pnpm start --url https://github.com/user/repo.git
+
 # Run in interactive chat mode
 pnpm start --interactive
 
@@ -159,13 +165,16 @@ pnpm start --access-mode readwrite --interactive
 
 | Option | Description | Default | Example |
 |--------|-------------|---------|---------|
-| `--path` | Path to the git repository | Current directory | `--path /path/to/repo` |
+| `--path` | Path to the local git repository | Current directory | `--path /path/to/repo` |
+| `--url` | URL of remote git repository (clones automatically) | - | `--url https://github.com/user/repo.git` |
 | `--branches` | Comma-separated list of branches to access | All branches | `--branches main,develop` |
 | `--access-mode` | Access mode: `readonly` or `readwrite` | `readonly` | `--access-mode readwrite` |
 | `--auto-commit` | Automatically commit changes (requires `readwrite` mode) | `false` | `--auto-commit` |
 | `--interactive` | Run in interactive chat mode | `false` | `--interactive` |
 | `--input` | Single question to ask | - | `--input "What branches exist?"` |
 
+**Note:** Either `--path` or `--url` must be provided. When using `--url`, the repository is cloned to a temporary directory automatically.
+
 ## How It Works: 3 Simple Steps
 
 ### 1. Create AFSGit Module
@@ -173,11 +182,19 @@ pnpm start --access-mode readwrite --interactive
 ```typescript
 import { AFSGit } from "@aigne/afs-git";
 
+// Option 1: Mount a local repository
 const afsGit = new AFSGit({
   repoPath: process.cwd(),
   accessMode: 'readonly',  // or 'readwrite' for modifications
   branches: ['main', 'develop']  // optional: limit branches
 });
+
+// Option 2: Clone and mount a remote repository
+const afsGitRemote = new AFSGit({
+  remoteUrl: 'https://github.com/user/repo.git',
+  branches: ['main'],  // single branch = optimized clone
+  depth: 1,  // shallow clone (faster)
+});
 ```
 
 ### 2. Mount It as an AFS Module
@@ -234,6 +251,9 @@ npx -y @aigne/example-afs-git --input "Find all TODO comments in the main branch
 # Code review
 npx -y @aigne/example-afs-git --input "Review the authentication code in src/auth/"
 
+# Explore a remote repository
+npx -y @aigne/example-afs-git --url https://github.com/octocat/Hello-World.git --input "What's in this repository?"
+
 # Interactive mode - ask follow-up questions
 npx -y @aigne/example-afs-git --interactive
 ```
@@ -248,6 +268,18 @@ npx -y @aigne/example-afs-git --interactive
 
 ## Use Cases
 
+### Explore Remote Repositories
+Analyze any public GitHub repository without cloning manually:
+```typescript
+const afs = new AFS()
+  .mount(new AFSGit({
+    remoteUrl: 'https://github.com/octocat/Hello-World.git',
+    branches: ['master'],  // single branch for fast clone
+    depth: 1  // shallow clone
+  }));
+// Ask: "What's the structure of this repository?"
+```
+
 ### Code Review Assistance
 Let AI help review code across branches:
 ```typescript
@@ -324,6 +356,18 @@ const afs = new AFS()
 
 ## Advanced Features
 
+### Remote Repository Cloning
+Automatically clone and mount remote repositories:
+```typescript
+const afsGit = new AFSGit({
+  remoteUrl: 'https://github.com/user/repo.git',
+  branches: ['main'],  // Single branch = --single-branch optimization
+  depth: 1,  // Shallow clone for faster setup
+  repoPath: './cache/repo'  // Optional: specify clone location
+});
+// Without repoPath, clones to temp directory automatically
+```
+
 ### Branch Filtering
 Only expose specific branches:
 ```typescript

package/index.test.ts

@@ -1,5 +1,5 @@
 import { expect, test } from "bun:test";
-import { runExampleTest } from "@aigne/test-utils/run-example-test.js";
+import { runExampleTest } from "@aigne/utils/test-utils/run-example-test";
 
 test(
   "should successfully run the chatbot",

package/index.ts

@@ -11,7 +11,10 @@ const argv = yargs()
   .option("path", {
     type: "string",
     describe: "Path to the git repo to mount",
-    default: ".",
+  })
+  .option("url", {
+    type: "string",
+    describe: "URL of the remote git repository",
   })
   .option("description", {
     type: "string",
@@ -29,17 +32,20 @@ const argv = yargs()
     default: false,
     describe: "Automatically commit changes to the mounted repo",
   })
-  .demandOption("path")
   .strict(false)
   .parseSync(process.argv);
 
+// Default to current directory if neither path nor url is provided
+const repoPath = argv.path || (argv.url ? undefined : ".");
+
 const aigne = await loadAIGNEWithCmdOptions();
 
 const afs = new AFS()
   .mount(new AFSHistory({ storage: { url: ":memory:" } })) // In-memory history for this example
   .mount(
     new AFSGit({
-      repoPath: argv.path,
+      repoPath: argv.url ? undefined : repoPath,
+      remoteUrl: argv.url,
       description: argv.description,
       accessMode: argv.accessMode as AFSAccessMode,
       autoCommit: argv.autoCommit,

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "@aigne/example-afs-git",
-  "version": "1.1.0",
+  "version": "1.74.0-beta",
   "description": "A demonstration of using AIGNE Framework with AFS git module",
-  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
-  "homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/afs-git",
   "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
+  "homepage": "https://www.aigne.io/framework",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/AIGNE-io/aigne-framework"
+    "url": "git+https://github.com/ArcBlock/aigne-framework"
+  },
+  "bugs": {
+    "url": "https://github.com/ArcBlock/aigne-framework/issues"
   },
+  "type": "module",
   "bin": "index.ts",
   "files": [
     ".env.local.example",
@@ -16,16 +23,17 @@
     "README.md"
   ],
   "dependencies": {
+    "@aigne/afs": "^1.11.0-beta.1",
+    "@aigne/afs-git": "^1.11.0-beta.1",
     "yargs": "^18.0.0",
-    "@aigne/afs": "^1.4.0",
-    "@aigne/afs-history": "^1.2.0",
-    "@aigne/afs-git": "^1.1.0",
-    "@aigne/core": "^1.72.0",
-    "@aigne/cli": "^1.59.0"
+    "@aigne/afs-history": "^1.74.0-beta",
+    "@aigne/cli": "^1.74.0-beta",
+    "@aigne/core": "^1.74.0-beta"
   },
   "devDependencies": {
     "@types/bun": "^1.2.22",
-    "@aigne/test-utils": "^0.5.69"
+    "@aigne/typescript-config": "0.0.0",
+    "@aigne/utils": "^1.74.0-beta"
   },
   "scripts": {
     "start": "bun run index.ts",