👌 IMPROVE: Deployment and memory workflows (#45)

* 👌 IMPROVE: Allow deployment even if no pipes

* 👌 IMPROVE: Memory create logs

* 👌 IMPROVE: Uncommitted changes command

* 👌 IMPROVE: contributing guide

Author: ahmadbilaldev

CONTRIBUTING.md

@@ -13,11 +13,13 @@ grlz 'new version'
 pnpm release
 pnpm update-examples
 ```
+
 ## Testing locally
 
 To test the changes locally, you can run the following command:
 
-- Use an example like the Next.js one
+- Navigate to an example's folder like the Next.js one in `examples/nextjs`.
+
 - Change the `package.json` to point to the local package for `baseai` and `@baseai/core` packages.
 
 ```json
@@ -31,9 +33,26 @@ To test the changes locally, you can run the following command:
 }
 ```
 
-Now run in the root `pnpm clean-all && pnpm install` and then run `pnpm dev` to start the development server.
+- Now run in the root:
+
+```bash
+pnpm clean-all && pnpm install
+```
+
+Then run the development server:
+
+```bash
+pnpm dev
+```
+
+- Run the BaseAI local server from the example's folder without using the @latest flag:
+
+```bash
+# In examples/nextjs folder
+npx baseai dev
+```
 
-By doing this, the Next.js app will use the local packages instead of the published ones.
+By doing this, the Next.js example will use the local packages instead of the published ones.
 
 ---
 

packages/baseai/src/deploy/index.ts

@@ -54,9 +54,8 @@ async function deploy({
 		const pipes = await readPipesDirectory({ spinner, pipesDir });
 		if (!pipes) {
 			p.outro(
-				`No pipes found. Skipping deployment. \nAdd a pipe by running: ${cyan(`npx baseai@latest pipe`)} command`
+				`No pipes found. Skipping deployment of pipes. \nAdd a pipe by running: ${cyan(`npx baseai@latest pipe`)} command`
 			);
-			process.exit(1);
 		}
 
 		const memoryDir = path.join(buildDir, 'memory');
@@ -85,8 +84,7 @@ async function deploy({
 				overwrite
 			});
 		}
-
-		await deployPipes({ spinner, pipes, pipesDir, account });
+		if (pipes) await deployPipes({ spinner, pipes, pipesDir, account });
 
 		p.outro(
 			heading({ text: 'DEPLOYED', sub: 'successfully', green: true })
@@ -100,7 +98,7 @@ async function deploy({
 
 		p.log.info(
 			`${dim(`Successfully deployed:`)}
-${dim(`- ${green(pipes?.length)} pipe${pipes.length !== 1 ? 's' : ''}
+${dim(`- ${green(pipes?.length)} pipe${pipes?.length !== 1 ? 's' : ''}
 - ${green(tools?.length ?? 0)} tool${tools?.length !== 1 ? 's' : ''}
 - ${green(memory?.length ?? 0)} memory${memory?.length !== 1 ? 'sets' : ''}`)}`
 		);

packages/baseai/src/memory/create.ts

@@ -16,7 +16,7 @@ const execAsync = promisify(exec);
 
 const defaultConfig = {
 	name: 'ai-agent-memory',
-	description: 'My list of docs for an AI agent pipe'
+	description: 'My list of docs as memory for an AI agent pipe'
 };
 
 const MEMORY_CONSTANTS = {
@@ -45,7 +45,7 @@ export async function createMemory() {
 				}),
 			description: () =>
 				p.text({
-					message: 'Description of the pipe',
+					message: 'Description of the memory',
 					placeholder: defaultConfig.description
 				}),
 			useGitRepo: () =>
@@ -78,6 +78,7 @@ export async function createMemory() {
 		memoryFilesDir = (await p.text({
 			message:
 				'Enter the path to the directory to track (relative to current directory):',
+			initialValue: '.',
 			validate: value => {
 				if (!value.trim()) {
 					return 'The path cannot be empty.';
@@ -174,7 +175,7 @@ export default ${memoryNameCamelCase};
 		p.outro(
 			heading({
 				text: memoryNameCamelCase,
-				sub: `created as a new pipe \n ${dim(figures.pointer)} ${dimItalic(` ${filePath}`)}`,
+				sub: `created as a new memory \n ${dim(figures.pointer)} ${dimItalic(` ${filePath}`)}`,
 				green: true
 			})
 		);

packages/baseai/src/utils/memory/git-sync/handle-git-sync-memories.ts

@@ -24,13 +24,19 @@ export async function handleGitSyncMemories({
 
 	// Check for uncommitted changes
 	try {
-		execSync('git diff-index --quiet HEAD --');
+		const hasChanges = execSync('git status --porcelain').toString().trim();
+		if (hasChanges) {
+			p.log.error(
+				`There are uncommitted changes in the Git repository for ${isEmbed ? 'embedding' : 'deploying'} git-synced memory "${memoryName}".`
+			);
+			p.log.info(
+				`Please commit these changes before ${isEmbed ? 'embedding' : 'deploying'}. Aborting.`
+			);
+			process.exit(1);
+		}
 	} catch (error) {
 		p.log.error(
-			`There are uncommitted changes in the Git repository for ${isEmbed ? 'embedding' : 'deploying'} git-synced memory "${memoryName}".`
-		);
-		p.log.info(
-			`Please commit these changes before ${isEmbed ? 'embedding' : 'deploying'}. Aborting.`
+			`Failed to check if there are uncommitted changes: ${error}`
 		);
 		process.exit(1);
 	}