Interactive AI markup for frontend developpers.
Install deno https://docs.deno.com/runtime/manual/getting_started/installation
$ deno install -Af https://deno.land/x/previs@0.1.10/previs.tsTo preview in vscode terminal, you need imgcat and vscode settings.
# cd under PATH
$ wget https://iterm2.com/utilities/imgcat
$ chmod +x imgcatLaunch command palette then Preferences: Open User Settings (JSON)
Previs works on vite project.
$ npm create vite@latest
# I recommend react-ts template
# cd <proj>(TODO: previs use vite but ignore project's vite.config.*)
Set PREVIS_OPENAI_API_KEY.
$ export PREVIS_OPENAI_API_KEY=...
# or OPENAI_API_KEYCheck with previs doctor.
$ previs doctor
✅ git
✅ code
✅ imgcat
✅ bat
✅ PREVIS_OPENAI_API_KEY is set
✅ vite: ./vite.config.mts
✅ package.json: ./package.json
✅ tsconfig.json: ./tsconfig.json
✅ compilerOptions.jsx: react-jsx
Library: react
Base: ./Run preview and fix interactively.
# Fix
$ previs src/button.tsx
# Fix with import (for tailwind and others)
$ previs src/button.tsx --import style.css
# Fix with image upload (CAUTION: many token used)
$ previs src/button.tsx --vision
# Preview with size
$ previs src/button.tsx -W 400px
# Generate new file
$ previs newfile.tsx
# Fix with test validation
$ previs src/button.tsx -- pnpm vitest --run __FILE__Put single file for preview in vite project.
- exported
__PREVIEW__
export function __PREVIEW__(/* shoud be non-props component */) {}
- Same symbol of filename(caseless)
Button.tsx=>export function Button() {...}
- exported
default
export default function App() {...}
# run after -- command before code accept and retry.
$ previs button.tsx -- pnpm vitest --run __FILE____FILE__ is replaced to generated temp file. (eg. button.__previs__.tsx)
- Create temporal
viteporject under.previs-* - Run
viteserver in deno - Run
puppeteerand take screenshot - Print screenshot by imgcat and
vscodeterminal image integration - Build prompt with current code and fixing request
- Send prompt to openai api to generate new code
- Print screenshot again
previs <options> -- [test-command]: Run test and retry automaticallyprevis --vision: Send screenshot to openai- Accepet generated code or add additional request
- Commands
- previs
- previs fix
- previs doctor
- previs init
- Integration
- react
- svelte
- vue
- qwik
- preact
- astro
- htmx
- Auto Detection
- UI library auto detection
- tailwind auto detection
- file named component detection
- panda-css
- ChakraUI
- load tailwind config
- format
- Load custom vite.config
- Zero config tailwind
- Load
previs.config.json - width/height
- show diff
- Autoload src/index.css
- Web UI
- VRT
- testing library sample
- Node package
- @previs/helper
- type-generator
- zundamon
MIT
{ // ... "terminal.integrated.enableImages": true, }