https://github.com/aignostics/typescript-sdk
Aignostics TypeScript SDK
https://github.com/aignostics/typescript-sdk
Last synced: 3 months ago
JSON representation
Aignostics TypeScript SDK
- Host: GitHub
- URL: https://github.com/aignostics/typescript-sdk
- Owner: aignostics
- License: mit
- Created: 2025-07-18T13:54:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-03-24T10:28:19.000Z (3 months ago)
- Last Synced: 2026-03-25T12:14:50.939Z (3 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.97 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Aignostics Platform TypeScript SDK
[](https://codecov.io/github/aignostics/typescript-sdk)
[](https://sonarcloud.io/summary/new_code?id=aignostics_typescript-sdk)
[](https://github.com/aignostics/typescript-sdk/actions/workflows/ci-cd.yml)
The official TypeScript SDK for the Aignostics Platform, providing type-safe access to the Aignostics API. Also includes a CLI tool for command-line operations.
For general information about the Aignostics Platform [check this documentation page](https://aignostics.readthedocs.io/en/latest/main.html#platform)
## Packages
- **[@aignostics/sdk](packages/sdk/)** - Core TypeScript SDK with auto-generated API clients
- **[@aignostics/cli](packages/cli/)** - Command-line interface for platform operations
## Features
- 🚀 **Type-safe API client** - Generated from OpenAPI specifications
- 🔧 **CLI tool** - Command-line interface for platform operations
- 🧪 **Comprehensive testing** - 85%+ code coverage with unit and integration tests
- 🛡️ **Code quality** - ESLint, Prettier, and SonarQube integration
## Installation
### SDK Package
```bash
npm install @aignostics/sdk
```
### CLI Package
```bash
npm install -g @aignostics/cli
```
## Usage
For detailed usage instructions, see the individual package documentation:
- **SDK Usage**: [packages/sdk/README.md](packages/sdk/README.md)
- **CLI Usage**: [packages/cli/README.md](packages/cli/README.md)
### Quick Start - SDK
```typescript
import { PlatformSDK } from '@aignostics/sdk';
const sdk = new PlatformSDK({
baseURL: 'https://api.aignostics.com',
tokenProvider: () => 'your-access-token-here',
});
// List applications
const applications = await sdk.listApplications();
// List application runs
const runs = await sdk.listApplicationRuns();
```
### Quick Start - CLI
```bash
# Install and use the CLI
npm install -g @aignostics/cli
aignostics info
```
## Developer Documentation
### Architecture & Development
- [HTTP Mocking Patterns](docs/HTTP_MOCKING.md) - Testing patterns for HTTP requests
- [Testing Conventions](docs/TESTING_CONVENTION.md) - Testing standards and best practices
- [Token Storage](docs/TOKEN_STORAGE.md) - CLI authentication implementation
- [Dependency Injection](docs/DEPENDENCY_INJECTION.md) - DI patterns and practices
## Development Setup
### Prerequisites
- Node.js 18+
- Docker (for OpenAPI code generation)
### Setup
```bash
# Clone the repository
git clone https://github.com/aignostics/typescript-sdk.git
cd typescript-sdk
# Install dependencies
npm install
# Build all packages
npm run build
```
### Nx Commands
```bash
# Build all packages
nx run-many -t build
# Test all packages
nx run-many -t test
# Work with individual packages
nx build sdk # Build only SDK
nx test cli # Test only CLI
nx codegen sdk # Generate OpenAPI client
```
### Available Scripts
- `npm run build` - Build all packages
- `npm run test` - Run all tests
- `npm run lint` - Lint all packages
- `npm run codegen` - Generate OpenAPI client for SDK
- `npm run clean` - Clean all build outputs
## Contributing
1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
### Commit Convention
This project uses [Conventional Commits](https://conventionalcommits.org/). Please format your commits accordingly:
- `feat:` - New features
- `fix:` - Bug fixes
- `docs:` - Documentation changes
- `style:` - Code style changes
- `refactor:` - Code refactoring
- `test:` - Test changes
- `chore:` - Build/tooling changes
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Support
For support, please open an issue on [GitHub](https://github.com/aignostics/typescript-sdk/issues) or contact the development team.
---
Made with ❤️ by the Aignostics team