GitFables
DashboardDocumentation
Account
Sign inGet Started

Installation Guide

Get GitFables set up on your system.

1

System Requirements

Ensure your system meets these requirements before installation.

  • Node.js 18.0.0 or higher
  • Git 2.20.0 or higher
  • npm 7.0.0 or higher (or equivalent package manager)
  • Modern web browser (Chrome, Firefox, Safari, Edge)
2

Install GitFables CLI

Install the GitFables CLI tool globally on your system.

terminal
Bash
npm install -g @gitfables/cli

Install GitFables CLI with npm

Or if you prefer yarn:

terminal
Bash
yarn global add @gitfables/cli

Install GitFables CLI with yarn

3

Configure Your Environment

Set up your environment variables and authentication.

  1. Create a .env file in your project root
  2. Add your GitFables API key:
    .env
    Bash
    GITFABLES_API_KEY=your_api_key_here

    Environment variables configuration

  3. Configure Git credentials if needed
4

Verify Installation

Verify that GitFables is installed correctly.

terminal
Bash
gitfables --version

Check GitFables CLI version

You should see the current version number displayed.

Next Steps

Now that you've installed GitFables, here's what to do next.

CLI Setup

Set up the GitFables CLI for local development.

Configuration

Configure GitFables for your needs.

Quick Start

Jump into creating your first story.

API Setup

Set up API access for automation.