Reframe documentation

Reframe documentation

Setup notes, operating instructions, reference material, and troubleshooting.

Browse guides

Contents

Reframe keeps the board local. Chat Storyboard adds a user-controlled Agent that can inspect the open project, discuss a scene, propose edits, and use the model providers you choose.

Quick start

Your first sequence in four moves

01

Open a story

Create a blank project or open a CineoBoard, Fountain, or Final Draft file.

02

Draw the beat

Sketch the frame, then add dialogue, action, notes, and timing.

03

Shape the sequence

Add, duplicate, reorder, and play boards until the rhythm works.

04

Deliver the plan

Print boards or export a PDF, animatic, images, or editorial handoff.

Chat Storyboard

A local Agent surface, connected to models you control.

Chat Storyboard reads a bounded snapshot of the open project, answers questions, and prepares reviewable edits. Reframe does not include a shared model credential: you connect your own provider and decide when the plugin is active.

1

Open the setup guide

In Reframe, choose Help → Chat Storyboard Setup…. You can also open Reframe → Settings and find AI Models.
2

Connect the required text model

Add the endpoint, deployment, API version, authentication type, and private API key provided by your model service.
3

Test before enabling

Choose Test text model. Continue only when Reframe reports that the connection is ready.
4

Enable and save

Select Enable Chat Storyboard plugin, choose Save AI settings, and return to the editor. The compact Chat Storyboard icon appears immediately on the left edge.
REFRAME 1.0.0
Reframe AI Models settings showing the three-step Chat Storyboard setup guide and required text model fields

The setup screen keeps the required text model first and environment variables under an advanced disclosure.

Connect a text model

Reframe's initial text configuration supports a GPT-5.6 deployment exposed through a Responses-compatible endpoint. The exact URL, deployment, API version, and credential come from your provider account—not from CineoBoard support.

FieldWhat to enter
Responses endpointThe HTTPS Responses API URL supplied by your model provider.
DeploymentThe exact deployment or model name created in your provider account.
API versionThe provider API version. Leave it empty only when your provider does not require one.
AuthenticationChoose Azure API key or Bearer token to match your provider.
API keyYour private provider credential. Reframe encrypts saved keys locally.

Add image generation (optional)

Image setup is optional. Without it, Chat Storyboard can still plan, review continuity, and propose text or metadata changes. Add one of these providers when you want new or transformed board images.

GPT Image 2

gpt-image-2

Generation and provider-supported image editing.

FLUX.2 Pro

flux-2-pro

High-quality generation through a configured FLUX endpoint.

FLUX.2 Flex

flux-2-flex

Flexible FLUX generation through your own deployment.

Configure an image-to-image endpoint only when your provider exposes a separate editing route. Always review generated artwork and your provider's usage terms before adding it to a production project.

Enable the plugin

  1. 1.Make sure Test text model succeeds.
  2. 2.Select Enable Chat Storyboard plugin.
  3. 3.Choose Save AI settings.
  4. 4.Return to the editor and select the Chat Storyboard icon on the left edge.
REFRAME 1.0.0
Reframe editor with the compact Chat Storyboard button visible on the left edge and no permanent sidebar

When configured and enabled, Chat Storyboard uses one compact button instead of a permanent rail. When the plugin is unavailable, the button is absent too.

Send a useful first request

Start narrow so the result is easy to judge. Mention the selected board, the decision you need, and whether you want analysis or a proposed project change.

Review the pacing of this scene and suggest only the changes that matter.

Find visual-continuity risks between the selected board and the boards around it.

Rewrite the selected board's action in one concise, filmable sentence.

Prepare a new establishing-board proposal that matches this scene's visual direction.

REFRAME 1.0.0
Chat Storyboard showing an Agent response and a change ready for review before the user applies it

Review changes before they touch the file

Chat Storyboard separates conversation from project mutation. Analysis appears as a normal response. A file-changing action appears in a clearly labelled review card with an Apply changes to project button.

  • Nothing changes while the proposal is waiting for review.
  • Apply only after the description matches your intent.
  • Reframe saves the accepted change through its normal project workflow.
  • Undo and Redo remain available after the change is accepted.

Environment variables (advanced)

Teams can provide provider settings from a controlled launcher or device-management system. Environment values override saved Settings values. Use placeholders in shared documentation; supply the real secret only on the user's device.

REFRAME_CHAT_STORYBOARD_TEXT_ENDPOINT=https://provider.example/openai/responses
REFRAME_CHAT_STORYBOARD_TEXT_DEPLOYMENT=your-deployment-name
REFRAME_CHAT_STORYBOARD_TEXT_API_VERSION=your-provider-api-version
REFRAME_CHAT_STORYBOARD_TEXT_AUTH_MODE=api-key
REFRAME_CHAT_STORYBOARD_TEXT_API_KEY=your-private-api-key
REFRAME_CHAT_STORYBOARD_ENABLED=1

Accepted activation values are 1, true, yes, and on. Image variables use the same prefix with IMAGE_PROVIDER, IMAGE_ENDPOINT, IMAGE_MODEL, and IMAGE_API_KEY.

Privacy and credentials

Encrypted locally

Provider keys saved in Settings use the operating system's secure storage and are never shown back in the interface.

Request only on submit

Reframe sends no Agent request while the plugin is off or while you are simply editing the board.

Bounded project context

Only the storyboard context needed for the request is sent to the model provider you configured.

Confirmation before writes

Proposed file changes stay pending until you explicitly apply them.

Troubleshooting and FAQ

Why is the Chat Storyboard icon missing?+

The editor keeps the feature completely hidden until a text endpoint, deployment, and API key are present and Enable Chat Storyboard plugin is turned on. Open Help → Chat Storyboard Setup…, test the text model, enable the plugin, and save.

Do I need an image model?+

No. A text model is enough for planning, scene review, dialogue and action changes, and other text-backed Agent work. Add an image provider only when you want the Agent to generate or transform frame images.

Does the Agent change my project automatically?+

No. Any file-changing action appears as a review card. The storyboard changes only after you choose Apply changes to project, and normal Reframe undo and redo remain available.

Why did the connection test fail?+

Check the endpoint path, deployment name, API version, authentication type, network access, provider quota, and whether the key is allowed to use that deployment. Never email your API key to support.

Can a Finder-launched Mac app read my shell variables?+

Not reliably. For an ordinary Mac launch, use Reframe's encrypted Settings. Environment variables are intended for a controlled launcher or a device-management deployment.

Draw and organize in Reframe

The Agent is optional; the core board remains a fast local workspace. Draw with seven tools, keep artwork on layers, edit dialogue/action/notes, arrange boards on the filmstrip, and press Space to judge the cut.

1

Sketch

Draw locally with the tool and layer controls.

2

Describe

Add dialogue, action, notes, timing, and shot details.

3

Sequence

Arrange boards and review the cut from the filmstrip.

4

Deliver

Print, export, or hand the project to editorial.

Print and export

Use File → Print / PDF to set paper, orientation, grid, metadata, and notes with a live preview. Reframe can also deliver animated GIF, video animatic, image archives, and editorial handoff formats from the same project.

Still stuck?

Tell us the last step that worked.

Include Reframe 1.0.0, your operating system, provider name, and the error message. Never include an API key.

support@cineoboard.com