@gadgetinc/ggt 0.4.9 → 1.0.0

package/README.md

@@ -18,8 +18,6 @@
 <br>
 <br>
 
-<i>Status: alpha -- please report any issues to the [issue tracker](https://github.com/gadget-inc/ggt/issues?q=is%3Aissue+is%3Aopen) here so we can fix them!</i>
-
 </div>
 
 ## Table of Contents
@@ -28,7 +26,12 @@
 - [Quick Start](#quick-start)
 - [Usage](#usage)
 - [Commands](#commands)
-  - [`ggt sync`](#ggt-sync)
+  - [`ggt dev`](#ggt-dev)
+  - [`ggt deploy`](#ggt-deploy)
+  - [`ggt status`](#ggt-status)
+  - [`ggt push`](#ggt-push)
+  - [`ggt pull`](#ggt-pull)
+  - [`ggt open`](#ggt-open)
   - [`ggt list`](#ggt-list)
   - [`ggt login`](#ggt-login)
   - [`ggt logout`](#ggt-logout)
@@ -37,194 +40,263 @@
 
 ## Intro
 
-`ggt` is the command line interface for the Gadget platform, providing additional functionality for working with your Gadget applications using your existing tools on your machine. `ggt` isn't required for building end-to-end Gadget apps but supports syncing files locally (and more soon) for your preferred coding experience.
+`ggt` is the command line interface for the Gadget platform, providing additional functionality for working with your Gadget applications using your existing tools on your machine.
 
 ## Quick Start
 
-Run the following to sync a `my-app.gadget.app` application to the `~/gadget/my-app` on your local machine:
+Assuming you have a Gadget application named `example`, run the following to clone your application's source code to `~/gadget/example` to begin developing:
 
 ```sh
-npx ggt@latest sync ~/gadget/my-app --app=my-app
+npx ggt@latest dev ~/gadget/example --app=example
 ```
 
-With this running in the background, your local `~/gadget/my-app` folder will become two-way synced with your application's filesystem in Gadget's cloud. Changes you make locally will be immediately reflected by your application's API and actions if you re-run them.
+While `ggt dev` is running, `~/gadget/example` will synchronized with your application's filesystem in Gadget's cloud. Any file changes you make locally will be immediately reflected by your application's API and actions if you re-run them.
 
 ## Usage
 
 ```sh-session
 $ npm install -g ggt
 $ ggt
-The command-line interface for Gadget
+The command-line interface for Gadget.
 
 USAGE
   ggt [COMMAND]
 
 COMMANDS
-  sync           Sync your Gadget application's source code
-  list           List your apps
-  login          Log in to your account
-  logout         Log out of your account
-  whoami         Print the currently logged in account
-  version        Print the version of ggt
+  dev              Start developing your application
+  deploy           Deploy your environment to production
+  status           Show your local and environment's file changes
+  push             Push your local files to your environment
+  pull             Pull your environment's files to your local computer
+  open             Open a Gadget location in your browser
+  list             List your available applications
+  login            Log in to your account
+  logout           Log out of your account
+  whoami           Print the currently logged in account
+  version          Print this version of ggt
 
 FLAGS
-  -h, --help     Print command's usage
-  -v, --verbose  Print verbose output
-      --json     Print output as JSON
+  -h, --help       Print how to use a command
+  -v, --verbose    Print more verbose output
+      --telemetry  Enable telemetry
 
-For more information on a specific command, use 'ggt [COMMAND] --help'
+Run "ggt [COMMAND] -h" for more information about a specific command.
 ```
 
 ## Commands
 
-### `ggt sync`
+### `ggt dev`
 
 ```sh-session
-$ ggt sync --help
-Sync your Gadget environment's source code with your local filesystem.
+$ ggt dev -h
+Develop your app by synchronizing your local files with your
+environment's files, in real-time. Changes are tracked from
+the last "ggt dev", "ggt push", or "ggt pull" run locally.
 
 USAGE
-  ggt sync [DIRECTORY]
+  ggt dev [DIRECTORY]
+
+EXAMPLES
+  $ ggt dev
+  $ ggt dev ~/gadget/example
+  $ ggt dev ~/gadget/example
+  $ ggt dev ~/gadget/example --app=example
+  $ ggt dev ~/gadget/example --app=example --env=development --prefer=local
 
 ARGUMENTS
-  DIRECTORY                  The directory to sync files to (default: ".")
+  DIRECTORY    The directory to synchronize files to (default: ".")
 
 FLAGS
-  -a, --app=<name>           The Gadget application to sync files to
-      --prefer=<filesystem>  Prefer "local" or "gadget" conflicting changes
-      --once                 Sync once and exit
-      --force                Sync regardless of local filesystem state
+  -a, --app=<name>           The application to synchronize files with
+  -e, --env=<name>           The environment to synchronize files with
+      --prefer=<filesystem>  Prefer "local" or "environment" conflicting changes
+
+  Run "ggt dev --help" for more information.
+```
+
+### `ggt deploy`
+
+```sh-session
+$ ggt deploy -h
+Deploy an environment to production.
+
+Your local files must match your environment's files
+before you can deploy. Changes are tracked from
+the last "ggt dev", "ggt push", or "ggt pull" run locally.
+
+USAGE
+  ggt deploy
+
+EXAMPLES
+  $ ggt deploy
+  $ ggt deploy --from=staging
+  $ ggt deploy --from=staging --force
+  $ ggt deploy --from=staging --force --allow-problems
+
+FLAGS
+  -a, --app=<name>      The application to deploy
+  -e, --from=<env>      The environment to deploy from
+      --force           Discard changes to your environment's filesystem
+      --allow-problems  Deploy regardless of any problems the environment has
+      --allow-charges   Deploy even if doing so will add charges to your account
+
+Run "ggt deploy --help" for more information.
+```
+
+### `ggt status`
+
+```sh-session
+$ ggt status -h
+Show file changes since your last dev, push, or pull.
+
+USAGE
+
+  ggt status
 
-DESCRIPTION
-  Sync allows you to synchronize your Gadget application's source
-  code with your local filesystem.
+EXAMPLES
 
-  While ggt sync is running, local file changes are immediately
-  reflected within Gadget, while files that are changed in Gadget are
-  immediately saved to your local filesystem.
+  $ ggt status
+```
 
-  Ideal for:
-    • Local development with editors like VSCode
-    • Storing source code in a Git repository like GitHub
+### `ggt push`
 
-  Sync looks for a ".ignore" file to exclude certain files/directories
-  from being synced. The format is identical to Git's.
+```sh-session
+$ ggt push -h
+Push your local files to your environment's filesystem.
+Changes are tracked from the last "ggt dev", "ggt push", or
+"ggt pull" run locally.
 
-  These files are always ignored:
-    • .DS_Store
-    • .gadget
-    • .git
-    • node_modules
+USAGE
+  ggt push
 
-  Note:
-    • Sync only works with your development environment
-    • Avoid deleting/moving all your files while sync is running
-    • Gadget only supports Yarn v1 for dependency installation
+EXAMPLES
+  $ ggt push
+  $ ggt push --env=staging
+  $ ggt push --env=staging --force
 
-EXAMPLE
-  $ ggt sync ~/gadget/example --app example
+FLAGS
+  -a, --app=<name>   The application to push files to
+  -e, --env=<name>   The environment to push files to
+      --force        Discard changes to your environment's filesystem
 
-    App         example
-    Editor      https://example.gadget.app/edit
-    Playground  https://example.gadget.app/api/graphql/playground
-    Docs        https://docs.gadget.dev/api/example
+  Run "ggt push --help" for more information.
+```
 
-    Endpoints
-      • https://example.gadget.app
-      • https://example--development.gadget.app
+### `ggt pull`
 
-    Watching for file changes... Press Ctrl+C to stop
+```sh-session
+$ ggt pull -h
+Pull your environment's files to your local filesystem.
+Changes are tracked from the last "ggt dev", "ggt push", or
+"ggt pull" run locally.
 
-    → Sent 09:06:25 AM
-    routes/GET-hello.js  + created
+USAGE
+  ggt pull
 
-    → Sent 09:06:49 AM
-    routes/GET-hello.js  ± updated
+EXAMPLES
+  $ ggt pull
+  $ ggt pull --env=staging
+  $ ggt pull --env=staging --force
 
-    ← Received 09:06:54 AM
-    routes/GET-hello.js  ± updated
+FLAGS
+  -a, --app=<name>   The application to pull files from
+  -e, --env=<name>   The environment to pull files from
+      --force        Discard changes to your local filesystem
 
-    ← Received 09:06:56 AM
-    routes/GET-hello.js  - deleted
-    ^C Stopping... press Ctrl+C again to force
+  Run "ggt pull --help" for more information.
+```
 
-    Goodbye!
+### `ggt open`
+
+```sh-session
+$ ggt open -h
+Open a Gadget location in your browser.
+
+USAGE
+  ggt open [LOCATION] [MODEL]
+
+EXAMPLES
+  $ ggt open
+  $ ggt open logs
+  $ ggt open permissions
+  $ ggt open data modelA
+  $ ggt open schema modelA
+  $ ggt open data --show-all
+  $ ggt open schema --show-all
+
+ARGUMENTS
+  LOCATION    The location to open
+  MODEL       The model to open
+
+FLAGS
+  -a, --app=<name>      The application to open
+  -e, --env=<env>       The environment to open
+      --show-all        Show all available models to open
+
+Run "ggt open --help" for more information.
 ```
 
 ### `ggt list`
 
 ```sh-session
-$ ggt list --help
-List the apps available to the currently logged in user.
+$ ggt list -h
+List your available applications.
 
 USAGE
   ggt list
 
-EXAMPLE
+EXAMPLES
   $ ggt list
-    Slug    Domain
-    ─────── ──────────────────
-    my-app  my-app.gadget.app
-    example example.gadget.app
-    test    test.gadget.app
 ```
 
 ### `ggt login`
 
 ```sh-session
-$ ggt login --help
+$ ggt login -h
 Log in to your account.
 
 USAGE
   ggt login
 
-EXAMPLE
+EXAMPLES
   $ ggt login
-    We've opened Gadget's login page using your default browser.
-
-    Please log in and then return to this terminal.
-
-    Hello, Jane Doe (jane@example.com)
 ```
 
 ### `ggt logout`
 
 ```sh-session
-$ ggt logout --help
+$ ggt logout -h
 Log out of your account.
 
 USAGE
   ggt logout
 
-EXAMPLE
+EXAMPLES
   $ ggt logout
-    Goodbye
 ```
 
 ### `ggt whoami`
 
 ```sh-session
-$ ggt whoami --help
-Show the name and email address of the currently logged in user
+$ ggt whoami -h
+Show the name and email address of the currently logged in user.
 
 USAGE
   ggt whoami
 
-EXAMPLE
+EXAMPLES
   $ ggt whoami
-    You are logged in as Jane Doe (jane@example.com)
 ```
 
 ### `ggt version`
 
 ```sh-session
-$ ggt version --help
-Print the version of ggt
+$ ggt version -h
+Print this version of ggt.
 
 USAGE
   ggt version
 
-EXAMPLE
+EXAMPLES
   $ ggt version
-    0.4.9
 ```

package/lib/__generated__/graphql.js

@@ -4,10 +4,75 @@
  *
  * You can regenerate it by running `npm run generate-graphql`.
  * ======================================================
- */ export var FileSyncEncoding;
+ */ export var BackgroundActionAttemptState;
+(function(BackgroundActionAttemptState) {
+    BackgroundActionAttemptState["Failed"] = "FAILED";
+    BackgroundActionAttemptState["Running"] = "RUNNING";
+    BackgroundActionAttemptState["Succeeded"] = "SUCCEEDED";
+})(BackgroundActionAttemptState || (BackgroundActionAttemptState = {}));
+export var BackgroundActionState;
+(function(BackgroundActionState) {
+    BackgroundActionState["Cancelled"] = "CANCELLED";
+    BackgroundActionState["Completed"] = "COMPLETED";
+    BackgroundActionState["Failed"] = "FAILED";
+    BackgroundActionState["Retrying"] = "RETRYING";
+    BackgroundActionState["Running"] = "RUNNING";
+    BackgroundActionState["Scheduled"] = "SCHEDULED";
+    BackgroundActionState["Waiting"] = "WAITING";
+})(BackgroundActionState || (BackgroundActionState = {}));
+export var EnvironmentStatus;
+(function(EnvironmentStatus) {
+    EnvironmentStatus["Active"] = "ACTIVE";
+    EnvironmentStatus["FatalError"] = "FATAL_ERROR";
+    EnvironmentStatus["Paused"] = "PAUSED";
+    EnvironmentStatus["Pending"] = "PENDING";
+})(EnvironmentStatus || (EnvironmentStatus = {}));
+export var EnvironmentType;
+(function(EnvironmentType) {
+    EnvironmentType["Development"] = "DEVELOPMENT";
+    EnvironmentType["Production"] = "PRODUCTION";
+    EnvironmentType["Test"] = "TEST";
+})(EnvironmentType || (EnvironmentType = {}));
+export var FileSyncEncoding;
 (function(FileSyncEncoding) {
     FileSyncEncoding["Base64"] = "base64";
     FileSyncEncoding["Utf8"] = "utf8";
 })(FileSyncEncoding || (FileSyncEncoding = {}));
+export var GadgetFieldType;
+(function(GadgetFieldType) {
+    GadgetFieldType["Any"] = "Any";
+    GadgetFieldType["Array"] = "Array";
+    GadgetFieldType["BelongsTo"] = "BelongsTo";
+    GadgetFieldType["Boolean"] = "Boolean";
+    GadgetFieldType["Code"] = "Code";
+    GadgetFieldType["Color"] = "Color";
+    GadgetFieldType["Computed"] = "Computed";
+    GadgetFieldType["DateTime"] = "DateTime";
+    GadgetFieldType["Email"] = "Email";
+    GadgetFieldType["EncryptedString"] = "EncryptedString";
+    GadgetFieldType["Enum"] = "Enum";
+    GadgetFieldType["File"] = "File";
+    GadgetFieldType["HasMany"] = "HasMany";
+    GadgetFieldType["HasManyThrough"] = "HasManyThrough";
+    GadgetFieldType["HasOne"] = "HasOne";
+    GadgetFieldType["Id"] = "ID";
+    GadgetFieldType["Json"] = "JSON";
+    GadgetFieldType["Money"] = "Money";
+    GadgetFieldType["Null"] = "Null";
+    GadgetFieldType["Number"] = "Number";
+    GadgetFieldType["Object"] = "Object";
+    GadgetFieldType["Password"] = "Password";
+    GadgetFieldType["RecordState"] = "RecordState";
+    GadgetFieldType["RichText"] = "RichText";
+    GadgetFieldType["RoleAssignments"] = "RoleAssignments";
+    GadgetFieldType["String"] = "String";
+    GadgetFieldType["Url"] = "URL";
+    GadgetFieldType["Vector"] = "Vector";
+})(GadgetFieldType || (GadgetFieldType = {}));
+export var ModelExportFormat;
+(function(ModelExportFormat) {
+    ModelExportFormat["Csv"] = "CSV";
+    ModelExportFormat["Ndjson"] = "NDJSON";
+})(ModelExportFormat || (ModelExportFormat = {}));
 
 //# sourceMappingURL=graphql.js.map