Skip to content

Repository files navigation

Kira

Kira is an open-source AI interface primarily for Hack Club AI, with support for external cloud & local OpenAI-compatible APIs. Kira does not sell user information. Chats stay on your device by default; if the optional account layer is enabled they are also mirrored to your account.

kira
  • Data is stored locally on your device, with optional account sync
  • Full Markdown & LaTeX Support
  • Document & image upload support
  • Image generation support
  • Sandboxed local projects & workspaces with code execution
  • Personalizable with name, occupation, and custom instructions
  • Web search & web crawling tools
  • Incognito mode to prevent chat history or memory from being saved
  • Opt-in notepad that remembers user details/preferences/opinions across chats
  • Conversation branching with message editing/regenerating
  • Context compression system
  • Programmable keybinds

Todo

  • voice-to-text input feature

You can suggest other ideas in the Issues tab of the GitHub repo

Setup

Clone Project and Move into Its Folder

git clone https://github.com/DragonSenseiGuy/kira.git
cd kira

Set Environment Variables

Copy .env.example to .env and fill it in:

Variable Required Purpose
NUXT_SESSION_SECRET Yes Signs session tokens and account cookies
DATABASE_URL No PostgreSQL connection string. Setting it turns on accounts + chat sync
NUXT_ENCRYPTION_KEY No Encrypts stored API keys. Falls back to NUXT_SESSION_SECRET

Install Dependencies

npm install

Run Unit Tests

npm test

Compile and Hot-Reload for Development

npm run dev

License

This project is licensed under the MIT License.

AI disclosure

AI coding assistance was used during implementation, debugging and build verification. Product direction and final acceptance remained with me.

About

An AI chat app

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages