Nutritious Pomegranate Muffins

    kikstart-agent-cli
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.0 • Public • Published

    kikstart-agent-cli

    oclif Version Downloads/week License

    Usage

    $ npm install -g kikstart-agent-cli
    $ kikstart-agent-cli COMMAND
    running command...
    $ kikstart-agent-cli (-v|--version|version)
    kikstart-agent-cli/1.2.0 darwin-x64 node-v12.14.1
    $ kikstart-agent-cli --help [COMMAND]
    USAGE
      $ kikstart-agent-cli COMMAND
    ...

    Commands

    kikstart-agent-cli agent:list [FILE]

    List registered agents

    USAGE
      $ kikstart-agent-cli agent:list [FILE]
    
    OPTIONS
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -s, --showToken                       Show Token
    

    See code: src/commands/agent/list.ts

    kikstart-agent-cli agent:register [FILE]

    Register an agent

    USAGE
      $ kikstart-agent-cli agent:register [FILE]
    
    OPTIONS
      -h, --help                            Show help
      -i, --id=id                           Agent ID (for local reference, defaults to hostname)
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -s, --secret=secret                   Agent Secret
      -u, --url=url                         Agent URL
    
    EXAMPLE
      ksa agent:register -u http://agent.local.kikstart.one/graphql -s "JWT SECRET"
    

    See code: src/commands/agent/register.ts

    kikstart-agent-cli agent:select

    List registered agents

    USAGE
      $ kikstart-agent-cli agent:select
    
    OPTIONS
      -h, --help                            Show help
      -i, --id=id                           Agent ID (local reference, see ks agent:list
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
    

    See code: src/commands/agent/select.ts

    kikstart-agent-cli agent:validate [FILE]

    Register an agent

    USAGE
      $ kikstart-agent-cli agent:validate [FILE]
    
    OPTIONS
      -h, --help                            Show help
      -i, --id=id                           Agent ID (for local reference, defaults to hostname)
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
    
    EXAMPLE
      ksa agent:register -u http://agent.local.kikstart.one/graphql -s "JWT SECRET"
    

    See code: src/commands/agent/validate.ts

    kikstart-agent-cli config

    Show user configuration

    USAGE
      $ kikstart-agent-cli config
    
    OPTIONS
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
    

    See code: src/commands/config/index.ts

    kikstart-agent-cli config:reset

    Reset user configuration

    USAGE
      $ kikstart-agent-cli config:reset
    
    OPTIONS
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
    

    See code: src/commands/config/reset.ts

    kikstart-agent-cli container:create [FILE]

    Create a container

    USAGE
      $ kikstart-agent-cli container:create [FILE]
    
    OPTIONS
      -h, --help                            Show help
      -i, --image=image                     (required) Image
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -s, --start                           Start
    

    See code: src/commands/container/create.ts

    kikstart-agent-cli deploy

    Deploy a folder

    USAGE
      $ kikstart-agent-cli deploy
    
    OPTIONS
      -f, --force
      -h, --help                            show CLI help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -n, --name=name                       name to print
    

    See code: src/commands/deploy.ts

    kikstart-agent-cli help [COMMAND]

    display help for kikstart-agent-cli

    USAGE
      $ kikstart-agent-cli help [COMMAND]
    
    ARGUMENTS
      COMMAND  command to show help for
    
    OPTIONS
      --all  see all commands in CLI
    

    See code: @oclif/plugin-help

    kikstart-agent-cli project:config

    describe the command here

    USAGE
      $ kikstart-agent-cli project:config
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/config.ts

    kikstart-agent-cli project:delete

    Delete project on agent

    USAGE
      $ kikstart-agent-cli project:delete
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -n, --project-name=project-name       Project name
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/delete.ts

    kikstart-agent-cli project:init

    Initialize project on agent

    USAGE
      $ kikstart-agent-cli project:init
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -n, --project-name=project-name       Project name
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/init.ts

    kikstart-agent-cli project:list

    Delete project on agent

    USAGE
      $ kikstart-agent-cli project:list
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/list.ts

    kikstart-agent-cli project:logs [FILE]

    Project container logs

    USAGE
      $ kikstart-agent-cli project:logs [FILE]
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/logs.ts

    kikstart-agent-cli project:restart [FILE]

    Restart project container(s)

    USAGE
      $ kikstart-agent-cli project:restart [FILE]
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/restart.ts

    kikstart-agent-cli project:start [FILE]

    Start project container(s)

    USAGE
      $ kikstart-agent-cli project:start [FILE]
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/start.ts

    kikstart-agent-cli project:status

    Project container(s) status

    USAGE
      $ kikstart-agent-cli project:status
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/status.ts

    kikstart-agent-cli project:stop [FILE]

    Stop project container(s)

    USAGE
      $ kikstart-agent-cli project:stop [FILE]
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -p, --path=path                       (required) [default: .] Project path
    

    See code: src/commands/project/stop.ts

    kikstart-agent-cli project:sync

    Sync project files to agent

    USAGE
      $ kikstart-agent-cli project:sync
    
    OPTIONS
      -b, --bucket=bucket                   (required) [default: default] Project bucket
      -d, --dry-run                         Dry run (does not sync)
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
      -p, --path=path                       (required) [default: .] Project path
      -w, --watch                           Watch mode
    

    See code: src/commands/project/sync.ts

    kikstart-agent-cli server:setup

    Generate agent server config

    USAGE
      $ kikstart-agent-cli server:setup
    
    OPTIONS
      -h, --help                            Show help
      -l, --logLevel=debug|error|info|warn  [default: info] Log level
    

    See code: src/commands/server/setup.ts

    kikstart-agent-cli utils:docker

    Show user configuration

    USAGE
      $ kikstart-agent-cli utils:docker
    
    OPTIONS
      -c, --command=context|df|ignore|enter|prune|prune-all  (required) Docker command
      -h, --help                                             Show help
      -l, --logLevel=debug|error|info|warn                   [default: info] Log level
    

    See code: src/commands/utils/docker.ts

    Keywords

    Install

    npm i kikstart-agent-cli

    DownloadsWeekly Downloads

    7

    Version

    1.2.0

    License

    MIT

    Unpacked Size

    142 kB

    Total Files

    73

    Last publish

    Collaborators

    • beeman