---
# System prepended metadata

title: rudr --help

---

# rudr --help

```console
$ rudr --help

✈️  A Micro App Plafrom for Kubernetes.

Commands
  Getting Started 🌱
    env             Set your enviroment (e.g. dev,stage,prod).
    dashboard       Open the dashbaord.
    docs            Open the rudr docs.
    
  Applications
    app             Create a new application. # Let's do multiple components (services?) as the future feature!
      
      init          # Prompt to choose workload, fill in workload parameters, and choose trait, fill in trait properties.
                    #
                    # Also supports:
                    #  $ rudr app init -f myapp.cue
                    #  $ rudr app init -f myapp.yaml (cue based app file)
      ls
      show
      status
      delete

  Workloads         # The most important thing is let user know how to use. e.g. $ rudr deployment --help should be super helpful (use definition object!)
    deployment      Stateless workload.
      
      run           Run this workload directly as a application, no trait. # Disbale in GUI
       
    cloneset        Stateful workload.
    ...
    
  Traits
    scale           Manually scale workload. e.g. $ rudr scale frontend -n 100
    autoscale       Automatically scale workload. e.g. $ rudr autoscale frontend -min 0 -max 100
    ...
    
  Release
    pipeline        # Future feature!
    snapshot        Snapshot the application.
      
      create
      checkout
 
  Others
    secret          Secret management.

       ls
       create       e.g. $ rudr secret create -f my.key

    config          Configmap management.

       ls
       create

    capability      Manage capability of the platform.

      config        Set the capability center, default is lcoal (built-in ones).
                    $ rudr cap config local
                    $ rudr cap config https://github.com/oam-dev/catalog
                    
      ls            $ rudr cap ls -t workload
      show          $ rudr cap show cloneset
      add           Install workload/trait to local so it will show up in --help
                    $ rudr cap add cloneset
      remove        $ rudr cap remove cloneset

      
  System

    
      completion      Build auto completion shell script
      admin           Administrator operations, like install/init
      
      
```

## CUE based AppFile

```yaml
name: myapp
components:
  frontend:
    deployment:
      image: inanimate/echo-server
      env:
        PORT: 8080
    traits:
      autoscaling:
        max: 10
        min: 1
      rollout:
        strategy: canary
        step: 5
      expose:
        service:
          type: LoadBalancer
        ports:
          http:
            service_port: 80
            container_port: 8080
    scopes:
      - public-scope
secrets:
  secret-foo:
    key1: cred
    key2: cred
appScopes:
  public-scope:
    networkPolicy: public
  private-scope:
    networkPolicy: private

```