Get Started
with ChapterWise

Set up your writing environment in minutes. Connect your tools, create your first codex, and start writing like a pro.

Setup Your Tools

Get your environment ready for writing

1

Create a ChapterWise Account

Your ChapterWise account is your hub for managing manuscripts, connecting to GitHub, and accessing AI-powered analysis. Get 10 free credits when you sign up.

2

Connect to GitHub

GitHub stores your manuscripts with version control, letting you track every change, branch for rewrites, and collaborate with editors.

Don't have a GitHub account?

GitHub is free for personal use. Create an account first, then connect it to ChapterWise.

Create GitHub Account
3

Select Your IDE

ChapterWise works with any text editor, but we recommend these powerful IDEs.

Install the Extension

Search for "ChapterWise Codex" in the extensions marketplace to get syntax highlighting and analysis tools.

ext install ChapterWise.codex
4

Create a Git Repository

Create a new repository on GitHub to store your codex files. This is where your writing will live.

Terminal

# Create a new directory for your project

$ mkdir my-codex-project

$ cd my-codex-project

# Initialize git

$ git init

Or create a new repository directly on GitHub:

Create New Repository
5

Add Repository to ChapterWise

Connect your repository to ChapterWise so it can sync your codex files and enable analysis.

  1. 1 Go to your ChapterWise Dashboard
  2. 2 Click "Add Project" or "Connect Repository"
  3. 3 Select your repository from the list
  4. 4 ChapterWise will automatically detect codex files
Go to Dashboard
Tools Ready

Create Your First Codex

Start writing with structured storytelling

6

Create Your First Codex File

A codex file is a YAML-based document that structures your story. You can create one from scratch, use AI to generate one, or start from a template.

my-story.codex.yaml
metadata:
  formatVersion: "1.1"
  author: "Your Name"

id: "my-first-story"
type: chapter
name: "Chapter One: The Beginning"

body: |
  The story begins here. Write your prose
  in the body field using multi-line YAML...
7

Push to Repository

Add your codex file to git and push it to GitHub. This will trigger ChapterWise to sync your content.

Terminal

# Add your codex file

$ git add my-story.codex.yaml

# Commit the changes

$ git commit -m "Add first chapter"

# Push to GitHub

$ git push origin main

8

View on ChapterWise

Once pushed, your codex file will appear in your ChapterWise project. From there you can:

View & Edit

See your story beautifully rendered

Share

Create shareable links for editors

Analyze

Run AI analysis on your writing

You're All Set!

Your writing environment is ready. Now it's time to create something amazing.

Start Writing