https://github.com/typpo/arkose

GPT-enhanced document editor
https://github.com/typpo/arkose

Last synced: 3 months ago
JSON representation

GPT-enhanced document editor

• Host: GitHub
• URL: https://github.com/typpo/arkose
• Owner: typpo
• License: agpl-3.0
• Created: 2022-11-06T02:11:49.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-11-16T01:38:27.000Z (12 months ago)
• Last Synced: 2024-05-23T00:39:51.848Z (6 months ago)
• Language: TypeScript
• Homepage:
• Size: 115 KB
• Stars: 128
• Watchers: 4
• Forks: 12
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• project-awesome - typpo/arkose - GPT-enhanced document editor (TypeScript)
• jimsghstars - typpo/arkose - GPT-enhanced document editor (TypeScript)

README

        
# Arkose, a GPT-3 enhanced document editor

Arkose is a no-frills document editor that talks with OpenAI's GPT-3 language model API.  

Reasons to use Arkose:

- **AI-assisted writing** - Writer's block?  Boilerplate?  Press a key to get AI help.

- **Dirt cheap** - Bring your own GPT-3 API key.  This is 50 to 2000x cheaper than commercial AI document editors.

- **Private and lightweight** - Arkose is a client.  Your documents are transmitted directly to GPT-3 without middle men.

- **Write in Markdown** - Formatting, headings, bullets, code, etc.

- **Portable** - Export your documents to other formats (markdown, html, docx, json)

**[» Learn more at the wiki «](https://github.com/typpo/arkose/wiki)**

## Try it

### [» Try the demo «](https://arkose.pages.dev/)

Press `⌘-Enter` or `Ctrl-Enter` to have GPT-3 contribute to your writing.

Note that demo completions are proxied through a worker that adds my OpenAI key.  Demo users are limited to N completions per day.  To run unlimited completions, enter your OpenAI key in `Settings` and/or run this project locally.

Completions work best when you've already written at least a few sentences.  For more usage tips, [visit the wiki](https://github.com/typpo/arkose/wiki).

## Demos









## Setup and installation

This project is built with vite.

- `yarn dev` - launch local development server

- `yarn build` - build for production in `dist/`

- `yarn preview` - preview production build locally