About this project
AWS Amplify CLI (Gen 1) is a command-line toolchain for simplifying serverless web and mobile application development. It uses AWS CloudFormation and nested stacks so developers can add or modify configurations locally before pushing them for execution in their AWS account. The README notes that Amplify Gen 1 is in maintenance mode: from May 1, 2026, Gen 1 backends receive only critical bug fixes and security patches, with end of life on May 1, 2027. New projects are directed to Amplify Gen 2, and existing Gen 1 users are encouraged to migrate using the provided guide and tooling.
Installation requires Node.js version 22 or later. The CLI is installed globally via npm as @aws-amplify/cli, followed by amplify configure to set AWS access credentials, region and a new AWS user profile.
Core commands include: amplify configure for credentials and profile setup; amplify init to initialize a project and prepare deployment resources; amplify configure project to update init settings; amplify add and amplify update for cloud features by category; amplify push to provision cloud resources from local changes, with a no-gql-override flag that skips automatic compilation of an annotated GraphQL schema and overrides local AppSync resolvers and templates; amplify pull to fetch upstream backend environment changes; amplify publish to run push and publish static assets to Amazon S3 and Amazon CloudFront when hosting is enabled; amplify status, including a verbose mode showing detailed diffs between local and deployed resources with cloudformation-diff; amplify serve to push and run the project start command; amplify delete to remove project resources; amplify help for core CLI help; amplify codegen add or generate for strongly typed objects from a GraphQL schema; and amplify env add, list, remove, get, pull, import and checkout for multi-environment workflows.
Category-specific commands cover auth (Amazon Cognito), storage (Amazon S3 and Amazon DynamoDB), function (AWS Lambda), api (AWS AppSync and Amazon API Gateway), analytics (Amazon Pinpoint), hosting (Amazon S3 and Amazon CloudFront distribution), notifications (Amazon Pinpoint), interactions (Amazon Lex), and predictions (Amazon Rekognition, Amazon Textract, Amazon Translate, Amazon Polly, Amazon Transcribe, Amazon Comprehend and Amazon SageMaker).
Tutorials linked from the README include a getting started guide, a GraphQL transform tutorial, and native development with the Amplify CLI and AWS AppSync. For development, contributors can set up a local environment, test a category using amplify-dev init and amplify-dev with a category subcommand, and run yarn lint at the top level before pushing code or opening a pull request, using yarn lint-fix in packages with errors and resolving remaining lint issues manually. Contribution guidelines are provided in the repository.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.