Nutella Peanut-Butter Marshmallow

    @guardian/cdk-cli
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    CDK CLI

    This project is still in the early stages of development and may not be stable

    oclif Version License

    CDK CLI is a tool to make it easier to get started with CDK using the @guardian/cdk library.

    Deprecation Notice

    We plan to deprecate this CLI and migrate all useful features to the main Guardian CDK repository. As a short-term fix for those looking to get a GuCDK stack up and running, here are some manual steps, expectations and notes regarding the process:

    Usage

    $ npm install -g @guardian/cdk-cli
    $ cdk-cli COMMAND
    running command...
    $ cdk-cli (-v|--version|version)
    @guardian/cdk-cli/2.0.0 darwin-x64 node-v14.18.0
    $ cdk-cli --help [COMMAND]
    USAGE
      $ cdk-cli COMMAND
    ...

    Commands

    cdk-cli help [COMMAND]

    display help for cdk-cli

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

    See code: @oclif/plugin-help

    cdk-cli new

    Creates a new CDK stack

    USAGE
      $ cdk-cli new
    
    OPTIONS
      -h, --help                                       show CLI help
      -v, --version                                    show CLI version
      --app=app                                        (required) The name of your application e.g. Amigo
    
      --init                                           Create the cdk directory before building the app and stack files
                                                       (defaults to true)
    
      --multi-app                                      Create the stack files within sub directories as the project defines
                                                       multiple apps (defaults to false)
    
      --stack=stack                                    (required) The Guardian stack being used (as defined in your
                                                       riff-raff.yaml). This will be applied as a tag to all of your
                                                       resources.
    
      --yaml-template-location=yaml-template-location  Path to the YAML CloudFormation template
    

    See code: src/commands/new.ts

    Development

    We follow the script/task pattern, find useful scripts within the script directory for common tasks.

    • ./script/setup to install dependencies
    • ./script/lint to lint the code using ESLint
    • ./script/test to run the Jest unit tests
    • ./script/build to compile TypeScript to JS

    There are also some other commands defined in package.json:

    • yarn lint --fix attempt to autofix any linter errors
    • yarn format format the code using Prettier

    However, it's advised you configure your IDE to format on save to avoid horrible "correct linting" commits.

    Keywords

    Install

    npm i @guardian/cdk-cli

    DownloadsWeekly Downloads

    19

    Version

    2.0.0

    License

    Apache-2.0

    Unpacked Size

    110 kB

    Total Files

    73

    Last publish

    Collaborators

    • unmesh_malvankar
    • zekehg
    • rtyley
    • dlawes
    • ghaberis
    • jsherbert
    • david.furey.gu
    • tonymccraeguardian
    • jlieb10
    • guardian-developers
    • simonadcock-gu
    • maxspencer
    • akash1810
    • reetta
    • ajwl
    • tomrf1
    • mchv
    • itsibitzi
    • justinpinner
    • jranks123
    • nicl
    • philmcmahon
    • tjmw
    • thaliasilver
    • sndrs
    • sam.hession
    • jfsoul
    • 0x101
    • frankie_hammond
    • aoifemcl15
    • ioanna0
    • mxdvl
    • mark.addis
    • rhysmills
    • jamie-lynch
    • amyhughes-gu
    • oliverlloyd
    • jacobwinch
    • dskamiotis
    • marjank
    • annabeddow
    • fweddi
    • michaelclapham_gnm
    • olly.namey.guardian