hub / github.com/Fallomai/spinai
github.com/Fallomai/spinai @main
Chat with this repo
181 symbols
583 edges
142 files
10 documented · 6%
● updated 9mo ago★ 350
Browse by type
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
SpinAI 🤖 (deprecated)
A lightweight framework for building AI agents with TypeScript
[Documentation](https://docs.spinai.dev) | [Discord](https://discord.gg/BYsRx36qR3)
Getting Started
Visit our documentation for:
- Installation guide
- Quick start tutorial
- API reference
- Examples and best practices
- Advanced usage
Quickstart
Create a New Project
Use our CLI to create a new SpinAI project:
npx create-spinai
Choose a template, and configure your .env
Read the README of the template you chose for a full list of env variables to setup.
Usually you'll need at minimum a .env file with your LLM's api key. All templates use OpenAI by default, but you can change the provider to your preferred LLM.
OPENAI_API_KEY=your_api_key_here
Run Your Agent
Start your agent:
npm run dev
Community
License
MIT © FallomAI
Extension points exported contracts — how you extend this code
Provider (Interface)
(no doc)
packages/spinai-mcp/src/index.ts
SpinAgentConfig (Interface)
(no doc)
packages/spinai-serve/src/index.ts
Action (Interface)
(no doc)
packages/spinai/src/actions/actions.types.ts
ButtonProps (Interface)
(no doc)
packages/ui/src/button.tsx
Template (Interface)
(no doc)
packages/create-spinai-app/index.ts
CreateDocUpdateAgentOptions (Interface)
(no doc)
templates/mintlify-docs-updater/src/index.ts
browse all types & interfaces →
Core symbols most depended-on inside this repo
↓ 37 filescreateAction
packages/spinai/src/actions/create.action.ts
↓ 16 filescreateAgentpackages/spinai/src/agents/create.agent.ts
↓ 9 filesagentpackages/spinai/src/agents/create.agent.ts
↓ 6 filescreateActionsFromMcpConfigpackages/spinai/src/mcp/mcp.ts
↓ 2 filescreateFullConfigtemplates/mintlify-docs-updater/src/config.ts
↓ 2 filescreateAssistantTextMessagepackages/spinai/src/messages/assistant.message.ts
Shape
Languages
TypeScript100%
Modules by API surface
templates/mintlify-docs-updater/src/types.ts15 symbols
packages/spinai/src/debug/debug.ts11 symbols
packages/spinai/src/logging/logging.ts9 symbols
templates/mintlify-docs-updater/src/actions/analyzeDocStructure.ts6 symbols
templates/mintlify-docs-updater/src/webhooks.ts5 symbols
templates/mintlify-docs-updater/src/actions/updateNavigation.ts5 symbols
templates/mintlify-docs-updater/src/actions/generateContent.ts5 symbols
templates/github-code-review-agent/src/actions/create-review-comments.ts5 symbols
packages/create-spinai-app/index.ts5 symbols
templates/mintlify-docs-updater/src/actions/planDocUpdates.ts4 symbols
templates/mintlify-docs-updater/src/actions/analyzeCodeChanges.ts4 symbols
templates/github-code-review-agent/src/pr-handlers.ts4 symbols
For agents
$ claude mcp add spinai \
-- python -m otcore.mcp_server <graph>