Agentic
TODO
- [Intro](#intro)
- [Development](#development)
- [Environment](#environment)
- [Local Testing](#local-testing)
- [Scratch](#scratch)
- [License](#license)
## Intro
TODO
## Development
- [node](https://nodejs.org/en) >= 18
- [pnpm](https://pnpm.io) >= 8
```bash
pnpm install
```
### Environment
```bash
cp .env.example .env
```
**Required**
- `OPENAI_API_KEY` - OpenAI API key.
- `REDIS_URL_TEST` - Redis server URL used for caching third-party API calls during testing.
**Optional**
- `ANTHROPIC_API_KEY` - [Anthropic](https://www.anthropic.com) API key ([docs](https://console.anthropic.com/docs))
- `SERPAPI_API_KEY` - [SerpApi](https://serpapi.com) API key ([docs](https://serpapi.com/search-api))
- `METAPHOR_API_KEY` - [Metaphor](https://metaphor.systems) API key ([docs](https://metaphorapi.readme.io/))
### Local Testing
Ensure you have `REDIS_URL_TEST` set to a valid redis connection URL.
```bash
pnpm test
```
Agentic uses [ava][ava] as its test runner. To just execute unit tests, run:
```bash
pnpm test:unit
```
To run a specific test, use the `--match` flag like so:
```bash
pnpm test:unit --match='name of the test'
```
### Scratch
- `@agentic/core`
- Task, Agentic, logging, caching, types, constants
- `@agentic/human-feedback`
- `@agentic/human-feedback-cli`
- `@agentic/human-feedback-sms`
- `@agentic/human-feedback-slack`
- `@agentic/experimenation`
- `@agentic/tools`
- `@agentic/tools-serpapi`
- `@agentic/tools-metaphor`
- `@agentic/tools-browser`
- `@agentic/tools-multion`
- `@agentic/llms`
- `@agentic/llms-openai`
- `@agentic/llms-anthropic`
- `@agentic/llms-huggingface`
- `@agentic/agents`
- `@agentic/cli`
## License
MIT © [Travis Fischer](https://transitivebullsh.it)
[ava]: https://github.com/avajs/ava