@aigne/afs-git 1.1.0 → 1.11.0-beta.1

package/LICENSE.md

@@ -1,93 +1,26 @@
-Elastic License 2.0
+# Proprietary License
 
-URL: https://www.elastic.co/licensing/elastic-license
+Copyright (c) 2024-2025 ArcBlock, Inc. All Rights Reserved.
 
-## Acceptance
+This software and associated documentation files (the "Software") are proprietary
+and confidential. Unauthorized copying, modification, distribution, or use of
+this Software, via any medium, is strictly prohibited.
 
-By using the software, you agree to all of the terms and conditions below.
+The Software is provided for internal use only within ArcBlock, Inc. and its
+authorized affiliates.
 
-## Copyright License
+## No License Granted
 
-The licensor grants you a non-exclusive, royalty-free, worldwide,
-non-sublicensable, non-transferable license to use, copy, distribute, make
-available, and prepare derivative works of the software, in each case subject to
-the limitations and conditions below.
+No license, express or implied, is granted to any party for any purpose.
+All rights are reserved by ArcBlock, Inc.
 
-## Limitations
+## Public Artifact Distribution
 
-You may not provide the software to third parties as a hosted or managed
-service, where the service provides users with access to any substantial set of
-the features or functionality of the software.
+Portions of this Software may be released publicly under separate open-source
+licenses (such as MIT License) through designated public repositories. Such
+public releases are governed by their respective licenses and do not affect
+the proprietary nature of this repository.
 
-You may not move, change, disable, or circumvent the license key functionality
-in the software, and you may not remove or obscure any functionality in the
-software that is protected by the license key.
+## Contact
 
-You may not alter, remove, or obscure any licensing, copyright, or other notices
-of the licensor in the software. Any use of the licensor’s trademarks is subject
-to applicable law.
-
-## Patents
-
-The licensor grants you a license, under any patent claims the licensor can
-license, or becomes able to license, to make, have made, use, sell, offer for
-sale, import and have imported the software, in each case subject to the
-limitations and conditions in this license. This license does not cover any
-patent claims that you cause to be infringed by modifications or additions to
-the software. If you or your company make any written claim that the software
-infringes or contributes to infringement of any patent, your patent license for
-the software granted under these terms ends immediately. If your company makes
-such a claim, your patent license ends immediately for work on behalf of your
-company.
-
-## Notices
-
-You must ensure that anyone who gets a copy of any part of the software from you
-also gets a copy of these terms.
-
-If you modify the software, you must include in any modified copies of the
-software prominent notices stating that you have modified the software.
-
-## No Other Rights
-
-These terms do not imply any licenses other than those expressly granted in
-these terms.
-
-## Termination
-
-If you use the software in violation of these terms, such use is not licensed,
-and your licenses will automatically terminate. If the licensor provides you
-with a notice of your violation, and you cease all violation of this license no
-later than 30 days after you receive that notice, your licenses will be
-reinstated retroactively. However, if you violate these terms after such
-reinstatement, any additional violation of these terms will cause your licenses
-to terminate automatically and permanently.
-
-## No Liability
-
-*As far as the law allows, the software comes as is, without any warranty or
-condition, and the licensor will not be liable to you for any damages arising
-out of these terms or the use or nature of the software, under any kind of
-legal claim.*
-
-## Definitions
-
-The **licensor** is the entity offering these terms, and the **software** is the
-software the licensor makes available under these terms, including any portion
-of it.
-
-**you** refers to the individual or entity agreeing to these terms.
-
-**your company** is any legal entity, sole proprietorship, or other kind of
-organization that you work for, plus all organizations that have control over,
-are under the control of, or are under common control with that
-organization. **control** means ownership of substantially all the assets of an
-entity, or the power to direct its management and policies by vote, contract, or
-otherwise. Control can be direct or indirect.
-
-**your licenses** are all the licenses granted to you for the software under
-these terms.
-
-**use** means anything you do with the software requiring one of your licenses.
-
-**trademark** means trademarks, service marks, and similar rights.
+For licensing inquiries, contact: legal@arcblock.io

package/README.md

@@ -29,10 +29,12 @@ import { AFSGit } from "@aigne/afs-git";
 const afs = new AFS();
 
 // Mount a git repository in read-only mode
-afs.mount(new AFSGit({
-  repoPath: '/path/to/repo',
-  accessMode: 'readonly'  // default
-}));
+afs.mount(
+  new AFSGit({
+    repoPath: "/path/to/repo",
+    accessMode: "readonly", // default
+  }),
+);
 ```
 
 ### Path Structure
@@ -54,22 +56,22 @@ afs.mount(new AFSGit({
 
 ```typescript
 // List all branches
-const branches = await afs.list('/modules/git');
+const branches = await afs.list("/modules/git");
 // Returns: ['/main', '/develop', '/feature-auth']
 
 // List files in a branch
-const files = await afs.list('/modules/git/main');
+const files = await afs.list("/modules/git/main");
 // Returns files at root of main branch
 
 // List files recursively
-const allFiles = await afs.list('/modules/git/main', { maxDepth: 10 });
+const allFiles = await afs.list("/modules/git/main", { maxDepth: 10 });
 
 // Read file content
-const content = await afs.read('/modules/git/main/README.md');
+const content = await afs.read("/modules/git/main/README.md");
 console.log(content.data?.content);
 
 // Search across branch
-const results = await afs.search('/modules/git/main', 'TODO');
+const results = await afs.search("/modules/git/main", "TODO");
 // Uses git grep for fast searching
 ```
 
@@ -79,56 +81,56 @@ const results = await afs.search('/modules/git/main', 'TODO');
 import { AFSGit } from "@aigne/afs-git";
 
 const afsGit = new AFSGit({
-  repoPath: '/path/to/repo',
-  accessMode: 'readwrite',
+  repoPath: "/path/to/repo",
+  accessMode: "readwrite",
   autoCommit: true,
   commitAuthor: {
-    name: 'AI Agent',
-    email: 'agent@example.com'
-  }
+    name: "AI Agent",
+    email: "agent@example.com",
+  },
 });
 
 afs.mount(afsGit);
 
 // Write a new file (creates worktree automatically)
-await afs.write('/modules/git/main/newfile.txt', {
-  content: 'Hello World'
+await afs.write("/modules/git/main/newfile.txt", {
+  content: "Hello World",
 });
 // Automatically committed with message "Update newfile.txt"
 
 // Update existing file
-await afs.write('/modules/git/main/src/index.ts', {
-  content: updatedCode
+await afs.write("/modules/git/main/src/index.ts", {
+  content: updatedCode,
 });
 
 // Delete file
-await afs.delete('/modules/git/main/oldfile.txt');
+await afs.delete("/modules/git/main/oldfile.txt");
 // Automatically committed
 
 // Rename/move file
-await afs.rename('/modules/git/main/old.txt', '/modules/git/main/new.txt');
+await afs.rename("/modules/git/main/old.txt", "/modules/git/main/new.txt");
 ```
 
 ### Advanced Configuration
 
 ```typescript
 const afsGit = new AFSGit({
-  repoPath: '/path/to/repo',
-  name: 'my-repo',
-  description: 'My project repository',
+  repoPath: "/path/to/repo",
+  name: "my-repo",
+  description: "My project repository",
 
   // Limit accessible branches
-  branches: ['main', 'develop'],
+  branches: ["main", "develop"],
 
   // Access control
-  accessMode: 'readwrite',
+  accessMode: "readwrite",
 
   // Auto-commit settings
   autoCommit: true,
   commitAuthor: {
-    name: 'AI Agent',
-    email: 'agent@example.com'
-  }
+    name: "AI Agent",
+    email: "agent@example.com",
+  },
 });
 
 // Cleanup worktrees when done
@@ -165,15 +167,16 @@ Worktrees are created in temporary directories and cleaned up when the module is
 ```typescript
 interface AFSGitOptions {
   // Required
-  repoPath: string;              // Path to git repository
+  repoPath: string; // Path to git repository
 
   // Optional
-  name?: string;                 // Module name (default: repo basename)
-  description?: string;          // Module description
-  branches?: string[];           // Limit accessible branches
-  accessMode?: 'readonly' | 'readwrite';  // Default: 'readonly'
-  autoCommit?: boolean;          // Auto-commit changes (default: false)
-  commitAuthor?: {               // Author for commits
+  name?: string; // Module name (default: repo basename)
+  description?: string; // Module description
+  branches?: string[]; // Limit accessible branches
+  accessMode?: "readonly" | "readwrite"; // Default: 'readonly'
+  autoCommit?: boolean; // Auto-commit changes (default: false)
+  commitAuthor?: {
+    // Author for commits
     name: string;
     email: string;
   };
@@ -202,10 +205,12 @@ import { AFS } from "@aigne/afs";
 import { AFSGit } from "@aigne/afs-git";
 
 const afs = new AFS();
-afs.mount(new AFSGit({
-  repoPath: process.cwd(),
-  accessMode: 'readonly'
-}));
+afs.mount(
+  new AFSGit({
+    repoPath: process.cwd(),
+    accessMode: "readonly",
+  }),
+);
 
 const aigne = new AIGNE({});
 
@@ -213,15 +218,11 @@ const aigne = new AIGNE({});
 const agent = AIAgent.from({
   name: "CodeReviewer",
   instructions: "Review code and suggest improvements",
-  afs
+  afs,
 });
 
 // Agent can list files, read code, search for patterns
 await aigne.invoke(agent, {
-  message: "Review the authentication code in src/auth/"
+  message: "Review the authentication code in src/auth/",
 });
 ```
-
-## License
-
-This project is licensed under the [Elastic-2.0](../../LICENSE.md) License.