npm - @defai.digital/automatosx - Versions diffs - 5.0.1 - Mend

@defai.digital/automatosx 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (77) hide show

package/CHANGELOG.md +2877 -0
package/CONTRIBUTING.md +357 -0
package/FAQ.md +604 -0
package/FIXES.md +277 -0
package/LICENSE +190 -0
package/README.md +603 -0
package/REVIEW-REPORT.md +278 -0
package/TROUBLESHOOTING.md +612 -0
package/automatosx.config.json +219 -0
package/dist/index.d.ts +2 -0
package/dist/index.js +11806 -0
package/dist/index.js.map +1 -0
package/docs/README.md +227 -0
package/docs/guide/core-concepts.md +568 -0
package/docs/guide/installation.md +406 -0
package/docs/guide/introduction.md +199 -0
package/docs/guide/quick-start.md +387 -0
package/docs/index.md +132 -0
package/docs/reference/cli-commands.md +894 -0
package/docs/tutorials/first-agent.md +691 -0
package/docs/tutorials/memory-management.md +785 -0
package/examples/AGENTS_INFO.md +293 -0
package/examples/README.md +434 -0
package/examples/abilities/best-practices.md +102 -0
package/examples/abilities/code-generation.md +1035 -0
package/examples/abilities/code-review.md +42 -0
package/examples/abilities/content-creation.md +97 -0
package/examples/abilities/debugging.md +43 -0
package/examples/abilities/documentation.md +54 -0
package/examples/abilities/error-analysis.md +107 -0
package/examples/abilities/general-assistance.md +26 -0
package/examples/abilities/our-architecture-decisions.md +242 -0
package/examples/abilities/our-code-review-checklist.md +217 -0
package/examples/abilities/our-coding-standards.md +389 -0
package/examples/abilities/our-project-structure.md +502 -0
package/examples/abilities/performance-analysis.md +56 -0
package/examples/abilities/problem-solving.md +50 -0
package/examples/abilities/refactoring.md +49 -0
package/examples/abilities/security-audit.md +65 -0
package/examples/abilities/task-planning.md +65 -0
package/examples/abilities/technical-writing.md +77 -0
package/examples/abilities/testing.md +47 -0
package/examples/abilities/troubleshooting.md +80 -0
package/examples/agents/assistant.yaml +45 -0
package/examples/agents/backend.yaml +60 -0
package/examples/agents/ceo.yaml +47 -0
package/examples/agents/coder.yaml +388 -0
package/examples/agents/cto.yaml +47 -0
package/examples/agents/data.yaml +47 -0
package/examples/agents/debugger.yaml +59 -0
package/examples/agents/design.yaml +46 -0
package/examples/agents/devops.yaml +47 -0
package/examples/agents/frontend.yaml +61 -0
package/examples/agents/product.yaml +47 -0
package/examples/agents/quality.yaml +47 -0
package/examples/agents/reviewer.yaml +49 -0
package/examples/agents/security.yaml +47 -0
package/examples/agents/writer.yaml +66 -0
package/examples/claude/commands/ax:agent.md +37 -0
package/examples/claude/commands/ax:clear.md +22 -0
package/examples/claude/commands/ax:init.md +25 -0
package/examples/claude/commands/ax:list.md +19 -0
package/examples/claude/commands/ax:memory.md +25 -0
package/examples/claude/commands/ax:status.md +24 -0
package/examples/claude/commands/ax:update.md +28 -0
package/examples/claude/mcp/automatosx.json +74 -0
package/examples/templates/analyst.yaml +60 -0
package/examples/templates/basic-agent.yaml +28 -0
package/examples/templates/designer.yaml +69 -0
package/examples/templates/developer.yaml +60 -0
package/examples/templates/qa-specialist.yaml +71 -0
package/examples/use-cases/01-web-app-development.md +374 -0
package/package.json +86 -0
package/scripts/check-release.js +128 -0
package/scripts/real-provider-test.sh +357 -0
package/scripts/smoke-test.sh +286 -0
package/tsup.config.ts +16 -0

package/CONTRIBUTING.md ADDED Viewed

@@ -0,0 +1,357 @@
+# Contributing to AutomatosX
+Thank you for your interest in contributing to AutomatosX! This document provides guidelines for contributing to the project.
+## Table of Contents
+- [Code of Conduct](#code-of-conduct)
+- [Getting Started](#getting-started)
+- [Development Setup](#development-setup)
+- [Making Changes](#making-changes)
+- [Testing](#testing)
+- [Submitting Changes](#submitting-changes)
+- [Coding Standards](#coding-standards)
+## Code of Conduct
+This project follows a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
+## Getting Started
+1. Fork the repository
+2. Clone your fork: `git clone https://github.com/yourusername/automatosx.git`
+3. Add upstream remote: `git remote add upstream https://github.com/automatosx/automatosx.git`
+## Development Setup
+### Prerequisites
+- Node.js 20.0.0 or later
+- npm, pnpm, or yarn
+### Installation
+```bash
+# Install dependencies
+npm install
+# Run tests
+npm test
+# Build the project
+npm run build
+# Run in development mode
+npm run dev -- <command>
+```
+## Making Changes
+### Creating a Branch
+```bash
+# Update your main branch
+git checkout main
+git pull upstream main
+# Create a feature branch
+git checkout -b feature/your-feature-name
+```
+### Branch Naming Convention
+- `feature/` - New features
+- `fix/` - Bug fixes
+- `docs/` - Documentation changes
+- `test/` - Test improvements
+- `refactor/` - Code refactoring
+- `perf/` - Performance improvements
+## Testing
+### Running Tests
+```bash
+# Run all tests
+npm test
+# Run unit tests only
+npm run test:unit
+# Run integration tests only
+npm run test:integration
+# Run tests in watch mode
+npm run test:watch
+# Run tests with coverage
+npm run test:coverage
+```
+### Writing Tests
+- Write tests for all new features
+- Maintain or improve test coverage (current: 67%)
+- Place unit tests in `tests/unit/`
+- Place integration tests in `tests/integration/`
+- Use descriptive test names
+- Follow existing test patterns
+### Test Requirements
+- All tests must pass before submitting PR
+- Coverage should not decrease
+- Add tests for bug fixes to prevent regression
+## Submitting Changes
+### Before Submitting
+1. **Run tests**: `npm test`
+2. **Type check**: `npm run typecheck`
+3. **Build**: `npm run build`
+4. **Update documentation** if needed
+5. **Update CHANGELOG.md** with your changes
+### Commit Messages
+Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
+```
+<type>(<scope>): <subject>
+<body>
+<footer>
+```
+**Types**:
+- `feat` - New feature
+- `fix` - Bug fix
+- `docs` - Documentation changes
+- `test` - Test changes
+- `refactor` - Code refactoring
+- `perf` - Performance improvements
+- `chore` - Build/tooling changes
+**Examples**:
+```
+feat(memory): add vector search optimization
+Implement caching layer for frequently accessed vectors
+to reduce query latency by 40%.
+Closes #123
+```
+```
+fix(cli): resolve path resolution bug in Windows
+Fix path separator issues when running on Windows.
+Add cross-platform path normalization.
+Fixes #456
+```
+### Pull Request Process
+1. **Update your branch**:
+   ```bash
+   git checkout main
+   git pull upstream main
+   git checkout your-branch
+   git rebase main
+   ```
+2. **Push to your fork**:
+   ```bash
+   git push origin your-branch
+   ```
+3. **Create Pull Request**:
+   - Use a clear, descriptive title
+   - Reference related issues
+   - Describe what changed and why
+   - Include screenshots for UI changes
+   - List breaking changes if any
+4. **PR Template**:
+   ```markdown
+   ## Description
+   Brief description of changes
+   ## Type of Change
+   - [ ] Bug fix
+   - [ ] New feature
+   - [ ] Breaking change
+   - [ ] Documentation update
+   ## Testing
+   - [ ] Tests pass locally
+   - [ ] Added/updated tests
+   - [ ] Manual testing completed
+   ## Checklist
+   - [ ] Code follows project style
+   - [ ] Documentation updated
+   - [ ] CHANGELOG.md updated
+   - [ ] No breaking changes (or documented)
+   ```
+5. **Review Process**:
+   - Address reviewer feedback
+   - Make requested changes
+   - Push updates to your branch
+   - Re-request review when ready
+## Coding Standards
+### TypeScript
+- Use TypeScript strict mode
+- Provide type annotations for all public APIs
+- Avoid `any` type unless absolutely necessary
+- Use meaningful variable and function names
+- Keep functions small and focused
+### Code Style
+```typescript
+// Good
+export async function loadProfile(
+  profilePath: string,
+  options: LoadOptions = {}
+): Promise<AgentProfile> {
+  // Implementation
+}
+// Bad
+export async function load(p: string, o: any) {
+  // Implementation
+}
+```
+### Documentation
+- Add JSDoc comments for all public APIs
+- Include parameter descriptions
+- Document return types
+- Provide usage examples
+```typescript
+/**
+ * Load an agent profile from a YAML file.
+ *
+ * @param profilePath - Absolute path to the profile file
+ * @param options - Optional loading configuration
+ * @returns Parsed agent profile
+ * @throws {PathTraversalError} If path is outside allowed directory
+ *
+ * @example
+ * ```typescript
+ * const profile = await loadProfile('/path/to/agent.yaml');
+ * console.log(profile.name); // 'my-agent'
+ * ```
+ */
+export async function loadProfile(
+  profilePath: string,
+  options: LoadOptions = {}
+): Promise<AgentProfile> {
+  // Implementation
+}
+```
+### File Organization
+```
+src/
+├── core/           # Core modules
+├── agents/         # Agent system
+├── providers/      # AI provider integrations
+├── cli/            # CLI commands
+├── types/          # TypeScript types
+└── utils/          # Utility functions
+```
+### Error Handling
+- Use custom error classes
+- Provide meaningful error messages
+- Include error context
+- Handle errors gracefully
+```typescript
+// Good
+if (!isValidPath(path)) {
+  throw new PathTraversalError(
+    `Invalid path: ${path}`,
+    { path, allowedDir }
+  );
+}
+// Bad
+if (!isValidPath(path)) {
+  throw new Error('bad path');
+}
+```
+### Performance
+- Avoid unnecessary computations
+- Use caching where appropriate
+- Lazy load when possible
+- Profile performance-critical code
+## Project Structure
+### Important Files
+- `src/` - Source code
+- `tests/` - Test suites
+- `docs/` - Documentation
+- `PRD/` - Product requirements
+- `examples/` - Example configurations
+### Key Modules
+1. **Core** (`src/core/`)
+   - `config.ts` - Configuration management
+   - `logger.ts` - Logging system
+   - `path-resolver.ts` - Path resolution
+   - `memory-manager.ts` - Memory persistence
+   - `router.ts` - Provider routing
+2. **Agents** (`src/agents/`)
+   - `profile-loader.ts` - Profile loading
+   - `abilities-manager.ts` - Abilities management
+   - `context-manager.ts` - Execution context
+3. **CLI** (`src/cli/`)
+   - Command implementations
+   - User interface
+## Getting Help
+- Check existing [documentation](docs/)
+- Search [existing issues](https://github.com/automatosx/automatosx/issues)
+- Ask in [discussions](https://github.com/automatosx/automatosx/discussions)
+- Join our [Discord](https://discord.gg/automatosx) (coming soon)
+## License
+By contributing, you agree that your contributions will be licensed under the MIT License.
+## Recognition
+Contributors will be recognized in:
+- CHANGELOG.md
+- GitHub contributors page
+- Release notes (for significant contributions)
+Thank you for contributing to AutomatosX! 🚀