FORJEX
Skip to documentation
Existing project

Getting started

Existing project

Use Forjex with application files you already have.

On this page

Before you start

Use this path when your application files already exist locally. Install its dependencies and confirm its build works first. You also need Git and a GitHub account with access to the destination repository.

Open the existing-project flow

1

Enter your application folder

cd my-project
forjex forge
2

Choose your starting point

Select Use the existing project in this directory. This uses your local files instead of generating a template.

3

Choose a repository

Select Create a new GitHub repository to publish these files to a new repository, or Push to an existing GitHub repository to use an existing remote. Review the destination before continuing.

Review generated configuration

The CLI asks about GitHub Actions and Vercel. Enable only what you want to configure. The CLI writes a workflow when CI/CD is selected; review an existing workflow before doing this.

The browser's Connect Existing Repo flow is different: it works on the remote repository, requires an initial commit, and adds only missing selected configuration. It preserves existing source files, README, workflows, and Vercel configuration.

Build, commit, and push

The CLI runs the detected build command before pushing. Fix a failed build locally, then run the existing-project flow again.

For an existing remote, the current CLI pulls from and pushes to main. Check your branch and remote first; if your repository uses another default branch, use the browser connection flow or configure the repository manually.

Inspect your repository
git status
git branch --show-current
git remote -v

Review local changes and remove secrets before committing. A successful push makes the selected files available to everyone with access to that GitHub repository.