Skip to content
Benjamin edited this page Mar 21, 2024 · 5 revisions

Getting Started

Install

To install CEPTA and to be used everywhere, install CEPTA with NPM as a global dependency with the -g tag.

npm install -g cepta

Updating

We are developing an automatic update reminder system and an automatic update system, but for now to update CEPTA we recommend you run the following command to install the latest version.

cepta update

This will get the latest version from NPM and will be used on your system.

Alternatively, you can use NPM to update CEPTA the same way you installed it.

npm i -g cepta

Checking Version

You can always check your version, and the current latest version by running the following command.

cepta version

If both numbers match up, you are all good! If they don't, you may want to run cepta update.

Usage

To use CEPTA, simply follow the following syntax.

cepta create <project-name>
  • create is the first argument and tells the tool to create a new project in your current direcotry.
  • is a required argument which is the name used in the package.json. Names cannot contain spaces or upper case letters.

Tip

After version 3.0.0, you no longer need to specify the create sub-method, as the pure cepta command will lead to an interactive CLI which will guide you through the process of creating the application

Naming Projects

When naming projects, your names cannot contain spaces or capital letters. A name like MyEpicProject would turn into myepicproject and This Is A Cool Project would become this.

When creating a project, the default files will be copied into your directory and the npm packages will be installed.

Help

You can run the following command to get the latest command help.

cepta help
Usage: cepta <command> <options>
Commands:
  create, c: Create a new project
    Options:
      <project name>: The name of the project
    Examples:
      cepta create banking-app-project
      cepta c silly-game-project
  version, v: Check the version of cepta
    Examples:
      cepta version
      cepta v
  help, h: Show this help message
    Examples:
      cepta help
      cepta h
  update, u: Update cepta
    Examples:
      cepta update
      cepta u

Clone this wiki locally