Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.inkwell.app/llms.txt

Use this file to discover all available pages before exploring further.

Inkwell is a native macOS application built using Swift and SwiftUI. This guide walks you through downloading, installing, and launching the app for the first time.

​
System requirements

Before installing, verify your Mac meets these requirements:
  • OS version: macOS 13.0 (Ventura) or later
  • Processor: Apple Silicon (M1/M2/M3/M4/M5/etc.) or Intel Core i5 or better
  • RAM: 8 GB minimum recommended
  • Disk space: ~200 MB for installation
  • Internet: Required for Quill AI features (offline writing is fully supported for local scripts)
Offline writing is fully supported. You only need internet to use Quill AI features and sync account details.

​
Download Inkwell

1

Visit the download page

Go to inkwell.app and click Download.
2

Get the DMG package

Download the macOS package: Inkwell.dmg.
3

Verify the download

Wait for the download to complete before opening the file.

​
Install on macOS

1

Open the installer package

Double-click the .dmg file you downloaded. A Finder window will appear showing the Inkwell application and your Applications folder.
2

Drag to Applications

Drag the Inkwell icon directly into the Applications folder shortcut in that window.
3

Launch Inkwell

Open your Applications folder and double-click Inkwell to launch the app.
4

Confirm security permissions

Because Inkwell is signed and notarized by Apple, it will run without warnings. If Gatekeeper prompts you to confirm opening an app downloaded from the internet, click Open.

​
First launch setup

When you open Inkwell for the first time, the native Startup Picker guides you through setup:
1

Welcome & sign in

Choose to sign in or create an account:
  • Continue with Google or Apple: Quick sign-in using your existing account.
  • Continue with Email: Enter your email address to receive a secure login link.
  • Use locally: Skip sign-in to work offline. Note that Quill AI is disabled without an account.
Quill AI features require an account and internet access. Local-only mode disables these assistant features.
2

Choose your plan

New accounts start on the Free Plan with:
  • Unlimited local scripts
  • 15 free Quill AI credits per month
  • Access to standard AI models
You can upgrade to Pro for unlimited AI access from your Account Settings.
3

Configure usage telemetry (optional)

Choose whether to share usage data. This helps us refine features and performance:
  • Share telemetry: Send anonymous performance metrics (no script content).
  • Do not share: Work with absolute privacy.
4

Start writing

The Startup Picker will display. Select New Script or open an existing .ink file.

​
Verify installation

After setup, confirm Inkwell is working properly:
Go to Inkwell Editor → About Inkwell in the macOS menu bar to see your current version number.
Create a new script, type a scene heading, and wait a moment. The status bar will show “Saved” automatically, showing disk synchronization works.
Open the Quill panel (Cmd+] or Cmd+0), click the input field, and type a short query. If Quill responds, AI services are online.
Installation complete! You’re ready to create your first screenplay.

​
Troubleshooting installation

If macOS displays a warning that the app cannot be opened because it was not downloaded from the App Store:
  1. Open System Settings on your Mac.
  2. Navigate to Privacy & Security.
  3. Scroll down to the security section and click Open Anyway next to the Inkwell alert.
  • Ensure your Mac has at least 500 MB of free storage.
  • If the app hangs, force quit it (Cmd+Option+Esc), drag the app from /Applications to the Trash, and re-install from the .dmg.
  • If problems persist, reach out to support@inkwell.app.

​
Next steps

Create your first script

Start a new screenplay and learn the basic workflow

UI overview

Explore the editor, panels, and navigation

Import existing scripts

Bring your existing Fountain or Final Draft files into Inkwell

Learn Fountain basics

Master screenplay formatting with Fountain syntax