Skip to main content

​
Overview

The timeback init command creates a timeback.config.json file in your project. This is the starting point for integrating with Timeback.
Staging credentials requiredtimeback init requires credentials from the Developer Portal. If you do not have credentials yet, complete first steps first.

​
Usage

timeback init

​
Modes

The init wizard offers two setup paths:

Initialize a new app

First-time setup. Prompts for app name, subjects, grades, and launch URL.

Import an existing app

Import existing courses from Timeback. Requires API credentials.

​
Interactive Prompts

When initializing a new app, you will be asked to configure:
  1. App name: Your application’s display name
  2. Courses: Subject and grade combinations to support
  3. Launch URL: The URL where your app is hosted

​
Options

​
--sync
flag
Push the config to Timeback after creating it
​
--config
string
Custom path for the config file (default: timeback.config.json)
​
-y, --yes
flag
Skip confirmation prompts

​
Examples

# Interactive setup
timeback init

# Initialize and sync to Timeback
timeback init --sync

# Custom config path
timeback init --config ./config/timeback.json

# Non-interactive (uses defaults)
timeback init --yes

​
What Gets Created

After running timeback init, you’ll have a timeback.config.json file: 
{
	"name": "My Learning App",
	"launchUrl": "https://myapp.example.com",
	"courses": [
		{
			"subject": "Math",
			"grade": 3,
			"ids": null
		}
	]
}
The ids field is null until you run timeback resources push.See Resources for more information.

​
Next Steps

Push Resources

Sync your resources

Configuration

Learn about all config options