mcs-codex v2.10.0

MCS-Codex

Install

npm install -g mcs-codex

Usage

Initalize project

codex init

Generate files

codex generate

Create codex configuration

codex configure

Help

Help will give you more information about the commands.

codex init --help
codex generate --help
codex configure --help

Install Issues

If you encounter an error with the message "execution of scripts is disabled on this system" when trying to run the command codex, run the command below to fix the problem.

Set-ExecutionPolicy RemoteSigned

In-Depth Use Cases:

Before Initializing a Codex Project, you must configure a few details so codex can setup your project successfully. To do this you can manually run codex configure to set up these details or you can just run codex init and codex will trigger configure if you are running codex init for the first time.

Running codex configure or codex c:

? Bitbucket App Client ID:  xxxxxxxxxxx
? Bitbucket App Client Secret:  xxxxxxxxxxx
? Bitbucket Workspace:  xxxxxxxxxxx
? AWS Production Account ID:  xxxxxxxxxxxxx
? AWS Development Account ID:  xxxxxxxxxxxx
? Enter Reviewers Bitbucket Username:  tombohonan
? Would you like add another bitbucket reviewer? Yes
? Enter Reviewers Bitbucket Username:  rvig
? Would you like add another bitbucket reviewer? No
[INFO] Codex configuration setup successfully

After you setup your codex configuration for the first time, you will see a folder by the name of .codex generated on your root directory. This directory will contain three files:

• credentials file -> contains your bitbucket access token & refresh token
• config file -> contains your bitbucket client id and client password, the bitbucket workspace you want to work with, your aws prod and dev account id's as well as the bitbucket reviewers you want to configure to your project
• cache file -> this will be generated upon running codex init, contains a cache to prevent additional fetches of reloading all the bitbucket projects that exists on your workspace

Running codex init for java-rest-listener OR serverless-rest-listener:

? Starter template: serverless-rest-listener
? Project name: RahCodexServerlessTest
? App domain: customer
? Bitbucket Project: Test Projects
  √ Create project files
  √ Create bitbucket repository
  √ Initialize local git repository
  √ Push initial commit
  √ Create and checkout test branch
  √ Configure bitbucket repository
DONE Project ready

Running codex generate for java-rest-listener OR serverless-rest-listener:

? What would you like to generate? adapter
? What type of adapter? service
? Name of service adapter: TestService
serverless-rest-listener-adapter-service
  √ Create file
DONE File ready

Running codex init for a template type of Rest Listener:

? Use cached bitbucket projects or reload projects? Cache
? Starter template: Java-Rest-Listener
? Project name: xxxxxxxxxxx
? Enter Application Group Id: xxxxxxxxxxx
? Enter Application Process Id: xxxxxxxxxxx
? Bitbucket Project: xxxxxxxxxxx
  √ Create project files
  √ Create bitbucket repository
  √ Initialize local git repository
  √ Push initial commit
  √ Create and checkout test branch
  √ Configure bitbucket repository
DONE Project ready

Running codex generate for template configuration-type:

? Starter template: (Use arrow keys)
> configuration-type
? Enter Configuration Type:  xxxxxxxxxxx
? Bitbucket Project: Test Projects
  √ Create project files
  √ Create bitbucket repository
  √ Initialize local git repository
  √ Push initial commit
  √ Create and checkout test branch
  √ Configure bitbucket repository

You can generate as many configuration types as you want. Once you’re done generating configuration types, open up your text/code editor and add content to the config types that were generated. Once done you can push the changes you made to the test branch that is automatically generated for your codex project. Once you push your changes to bitbucket, this will trigger the pipelines and push these configuration types as well as your config-meta.json (when pushing a rest listener codex app) to amazon S3 within the mcs-codex-config bucket under mcs-codex-config/configurations/{config_id}, mcs-codex/groups/{group_id} and mcs-codex/processes/{process_id}.