loKal

• Requirements
• Usage
• Workspace Config
• App config
• Commands

Requirements

• skaffold

• git

Usage

$ npm install -g lokal-cli
$ lkl COMMAND
running command...
$ lkl (--version)
lokal-cli/0.5.0 darwin-arm64 node-v16.14.0
$ lkl --help [COMMAND]
USAGE
  $ lkl COMMAND
...

Workspace Config

version: lokal/v1alpha1
kind: Workspace
name: foo 
namespace: foo
helmReleases:
  - name: mongodb
    portForward: # (optional)
      - localPort: 3000
        port: 3000 
        resourceType: Service # (optional) default: Service
        resourceName: mongodb # (optional) default: name
    spec:
      chartPath: ./charts/mongodb
  - name: redis
    spec: 
      repo: https://charts.bitnami.com/bitnami
      remoteChart: redis
      version: 16.8.5
      valuesFiles: # (optional)
        - ./charts/redis/values.yaml
apps:
  - name: app1
    portForward: # (optional)
      - localPort: 3000
        port: 3000 # (optional) # default: app.deployment.port
        resourceType: Service # (optional) default: Service
        resourceName: app1 # (optional) default: name
    lokalFile: ".lokal" # (optional) default: .lokal
    spec:
      env: # (optional) append or override the App env config
        FOO: "workspaceFoo"
      repository:
        localPath: "./apps/service1"
        repoUrl: "[email protected]:vargaadam/example-service.git" # (optional)
        branch: "dev" # (optional)

App config

version: lokal/v1alpha1
kind: App
name: service1
manifests:
  configMap: # (optional)
    fromFile: .env.example
    env:
      FOO: FOO
  deployment:
    replicas: 1 # (optional) default: 1
    size: NO_LIMIT | SMALL | MEDIUM | LARGE # (optional) default: NO_LIMIT
    port: 3000
build:
  docker:
    dockerfile: Dockerfile
  buildArgs: # (optional)
    BUILD_ARG: build_arg
  sync:
    manual:
      - src: "src/**/*.js"
        dest: .

Commands

• lkl clone WORKINGDIR
• lkl generate WORKINGDIR
• lkl help [COMMAND]

lkl clone WORKINGDIR

USAGE
  $ lkl clone [WORKINGDIR] [-w <value>] [-o <value>] [--pull]

FLAGS
  -o, --outDir=<value>     [default: .lokal] The directory of the generated manifests
  -w, --workspace=<value>  [default: .lokal.yaml] The workspace config file name
  --pull

EXAMPLES
  $ lkl clone WORKING_DIR

See code: dist/commands/clone/index.ts

lkl generate WORKINGDIR

USAGE
  $ lkl generate [WORKINGDIR] [-w <value>] [-o <value>] [--reset]

FLAGS
  -o, --outDir=<value>     [default: .lokal] The directory of the generated manifests
  -w, --workspace=<value>  [default: .lokal.yaml] The workspace config file name
  --reset                  Removes the output directory before generating

EXAMPLES
  $ lkl generate WORKING_DIR

See code: dist/commands/generate/index.ts

lkl help [COMMAND]

Display help for lkl.

USAGE
  $ lkl help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for lkl.

See code: @oclif/plugin-help