shopify-cli 1.3.1 → 1.7.0

data/docs/app/rails/index.md

@@ -1,36 +1,4 @@
 ---
-title: Getting started with Rails app projects
-section: rails
-toc: false
+title: Getting started with Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/getting-started
 ---
-
-## Create a new Rails app project
-
-To create a new Rails project, type `shopify create rails`. This will scaffold a new Rails app in a subdirectory.
-
-```console
-$ shopify create rails
-? App Name
->
-```
-
-## Start a local development server
-
-Once your app is created, you can work with it immediately by running `shopify serve` to start a local development server. Shopify App CLI uses [ngrok](https://ngrok.com) to create a tunnel. ngrok will choose a unique URL for you. The server will stay open until you type **Ctrl-C**.
-
-```console
-$ shopify serve
-✓ ngrok tunnel running at https://example.ngrok.io
-✓ writing .env file...
-```
-
-## Install your app on your development store
-
-With the server running, open a new terminal window and run `shopify open` to open your app in your browser and install it on a development store.
-
-```console
-$ shopify open
-```
-
-For more information, consult the [Rails project command reference]({{ site.baseurl }}{% link app/rails/commands/index.md %}).
-

data/docs/core/index.md

@@ -1,86 +1,4 @@
 ---
-title: Core commands
-section: core
+title: Shopify App CLI core commands
+redirect_to: https://shopify.dev/tools/cli/reference
 ---
-
-## `help`
-
-Lists the available commands and describes what they do. The commands available will vary depending on whether you are inside a project directory, and what kind of project it is.
-
-```console
-$ shopify help
-$ shopify -h
-$ shopify --help
-```
-
-You can also use the `help` command or options to get more detailed information about a specific command:
-
-```console
-$ shopify help [command]
-$ shopify [command] -h
-$ shopify [command] --help
-```
-
-## `connect`
-
-Connect an existing Shopify App CLI project with Shopify, such as a Partner account or a specific Shopify development store. This command re-creates the project’s `.env` file with your authentication tokens.
-
-This is useful if you are working on one project across multiple computers, or collaborating with other developers using a version control system like git.
-
-```console
-$ shopify connect
-```
-
-## `create`
-
-Create a new project of the specified type. The project will be created in a subdirectory of the current directory:
-
-```console
-$ shopify create
-```
-
-When running the `create` command on its own, the CLI will prompt you to choose a project type:
-
-```console
-$ shopify create
-? What type of project would you like to create? (Choose with ↑ ↓ ⏎, filter with 'f')
-> 1. Node.js App
-  2. Ruby on Rails App
-```
-
-You can also specify the type of app you want to create using a subcommand:
-- For a Node.js app: `node`
-- For a Ruby on Rails app: `rails`
-
-If you specify a type, then Shopify App CLI will skip ahead and prompt you to enter a name for your project:
-
-```console
-$ shopify create node
-? App Name
-> 
-```
-
-## `logout`
-
-Log out of the currently authenticated partner organization and store. The `logout` command clears any invalid credentials. You’ll need to re-authenticate the next time you connect your project to Shopify.
-
-```console
-$ shopify logout
-```
-
-## `config`
-
-Configure Shopify App CLI options. Currently there are two available options.
-
-### `analytics`
-
-Configure anonymous usage reporting by enabling or disabling analytics 
-```console
-$ shopify config analytics [ --status | --enable | --disable ]
-```
-
-### `feature`
-Configure active [feature sets](https://github.com/Shopify/shopify-app-cli/wiki/Feature-Sets) in the CLI. This command is used for development and debugging work on the CLI tool itself. Only alter it if you know what you're doing. Check the [Shopify App CLI development guide](https://github.com/Shopify/shopify-app-cli/wiki) for more information.
-```console
-$ shopify config feature [ feature_name ] [ --status | --enable | --disable ]
-```

data/docs/getting-started/index.md

@@ -1,27 +1,4 @@
 ---
-title: Getting started
-section: getting-started
-toc: false
+title: Getting started with Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/getting-started
 ---
-
-Developers should have some prior knowledge of the [Shopify app ecosystem](https://shopify.dev/concepts/apps). Shopify App CLI creates apps using either [Node.js](https://nodejs.org/) or [Ruby on Rails](https://rubyonrails.org/).
-
-## Requirements
-
-- A [Shopify partner account](https://partners.shopify.com/signup)
-- A [Shopify development store](https://help.shopify.com/en/partners/dashboard/development-stores#create-a-development-store) to install and test apps
-- [Ruby](https://www.ruby-lang.org) 2.5.1+ 
-
-### Windows requirements
-
-If you wish to use Shopify App CLI natively on **Windows 10**, we recommend installing Ruby using [RubyInstaller for Windows](https://rubyinstaller.org/downloads/).
-
-Alternatively, you can also use Shopify App CLI using **Windows Subsystem for Linux**, in which case you need:
-- [Linux Subsystem for Windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
-- [Ubuntu VM](https://www.microsoft.com/en-ca/p/ubuntu/9nblggh4msv6)
-
-## Next steps
-
-- [Install the CLI]({{ site.baseurl }}/getting-started/install/)
-- [Upgrade]({{ site.baseurl }}/getting-started/upgrade/)
-- [Uninstall]({{ site.baseurl }}/getting-started/uninstall/)

data/docs/getting-started/install/index.md

@@ -1,121 +1,4 @@
 ---
 title: Install Shopify App CLI
-section: getting-started
-toc: false
-redirect_from: "/install/"
+redirect_to: https://shopify.dev/tools/cli/installation
 ---
-
-Shopify App CLI can be installed on a variety of systems, using a variety of package managers.
-> Note that for systems that have multiple installation options, you only need to use one of these methods to install.
-
----
-### macOS
-
-Shopify App CLI is available through Homebrew _or_ RubyGems.
-
-**Homebrew**
-
-You’ll need to run `brew tap` first to add Shopify’s third-party repositories to Homebrew.
-
-```console
-$ brew tap shopify/shopify
-$ brew install shopify-cli
-```
-
-**RubyGems**
-
-See the [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygems-all-platforms) section for further details.
-
----
-
-### Debian/Ubuntu Linux
-
-On Debian-based Linux systems, Shopify App CLI is available through the `apt` command _or_ RubyGems.
-
-**apt**
-
-You’ll need to install a downloaded `.deb` file with an explicit version number. Check the [releases page](https://github.com/Shopify/shopify-app-cli/releases) to make sure you install the latest package.
-
-1. Download the `.deb` file from the [releases page](https://github.com/Shopify/shopify-app-cli/releases)
-1. Install the downloaded file
-```console
-$ sudo apt install /path/to/downloaded/shopify-cli-x.y.z.deb
-```
-
-**RubyGems**
-
-See the [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygems-all-platforms) section for further details.
-
----
-
-### CentOS 8+/Fedora/Red Hat/SUSE Linux
-
-On RPM-based Linux systems, Shopify App CLI is available through the `yum` command _or_ RubyGems.
-
-**yum**
-
-You’ll need to install a downloaded `.rpm` file with an explicit version number. Check the [releases page](https://github.com/Shopify/shopify-app-cli/releases) to make sure you install the latest package.
-
-1. Download the `.rpm` file from the [releases page](https://github.com/Shopify/shopify-app-cli/releases)
-1. Install the downloaded file
-```console
-$ sudo yum install /path/to/downloaded/shopify-cli-x.y.x.rpm
-```
-
-**RubyGems**
-
-See the [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygems-all-platforms) section for further details.
-
----
-
-### Windows 10
-
-On Windows 10 systems, Shopify App CLI is available through [RubyGems]({{ site.baseurl }}/getting-started/install/#rubygem-all-platforms).
-
----
-
-### RubyGems (all platforms)
-
-Shopify App CLI is available on all platforms as a RubyGem through [RubyGems.org](https://rubygems.org/).
-
-```console
-$ gem install shopify-cli
-```
-
----
-
-### To check that Shopify App CLI is installed correctly:
-
-```console
-$ shopify version
-1.0.0
-$
-```
-
-> Note 1: the version displayed may be newer.
-
-> Note 2: If you have the `shopify_api` gem installed, you may see the following response:
-> ```console
-> shopify command is no longer bundled with shopify_api.
-> if you need these tools, install the shopify_cli gem
-> ```
-> 
-> If so, then you will also need to upgrade the `shopify_api` gem to v9.2.0+ to remove a deprecated `shopify` command that is contained in that gem.
->
-> If you also have the `shopify_app` gem (which depends on `shopify_api` gem), you'll need to install or update `shopify_api` first, then uninstall the older version.
-> 
-> To get a list of the version(s) of `shopify_api` currently installed:
-> ```console
-> $ gem list shopify_api
-> ```
-> 
-> To install the latest version:
-> ```console
-> $ gem install shopify_api
-> ```
-> 
-> To uninstall the older version:
-> ```console
-> $ gem uninstall shopify_api -v x.y.z
-> ```
-> Replace x.y.z with a version number listed from the `gem list` command.  Repeat as needed.

data/docs/getting-started/migrate/index.md

@@ -1,96 +1,4 @@
 ---
-title: Migrate from the legacy Shopify App CLI
-section: getting-started
-redirect_from: "/migrate/"
+title: Troubleshooting Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/troubleshooting
 ---
-
-As of version 0.9.0, Shopify App CLI is installed and managed as a software package, instead of as a git repository. If you’re using a legacy version, you’ll need to perform a one-time migration to keep using the CLI. Follow these steps to remove the legacy version and reinstall as a package.
-
-## Check whether you’re using the legacy version
-
-Prior to version 0.9.0, Shopify App CLI was installed as a Git repository. You can determine if you’re running a legacy version by running this command:
-
-```console
-$ shopify version
-```
-
-If you get a “Command not found” error, then you’re using a legacy version and will need to uninstall it manually.
-
-## 1. Uninstall the legacy Shopify App CLI
-
-There are two steps to completely uninstall the legacy version of Shopify App CLI:
-
-1. Delete the legacy CLI files
-1. Remove the legacy `shopify` command from your shell profile
-1. Reload your terminal
-
-### 1. Delete the CLI files
-
-By default, Shopify App CLI was installed in your home directory. All the files are contained in a hidden directory called `.shopify-app-cli`. Delete it to uninstall:
-
-```console
-$ rm -rf ~/.shopify-app-cli/
-```
-
-### 2. Remove the `shopify` command from your shell
-
-During the install process, Shopify App CLI added a line to your shell configuration. This line could be located in one of a few possible files in your home directory:
-
-- `~/.bash_profile`
-- `~/.zshrc`
-- `~/.bash_login`
-- `~/.profile`
-- `~/.config/fish/config.fish`
-
-It will look similar to one of the lines below. The exact syntax may vary depending on your system:
-
-```sh
-# The line won’t look *exactly* like this. `HOME_DIR` will instead be the absolute path to your home directory.
-if [[ -f /HOME_DIR/.shopify-cli/shopify.sh ]]; then source /HOME_DIR/.shopify-cli/shopify.sh; fi
-
-# The line might not be wrapped in an `if` statement. Example:
-[ -f "/HOME_DIR/.shopify-app-cli/shopify.sh" ] && source "/HOME_DIR/.shopify-app-cli/shopify.sh"
-```
-
-Deleting or commenting out the relevant line in your shell profile will remove `shopify` as a command.
-
-### 3. Reload your terminal
-
-For the changes above to take effect, exit your terminal, and start a new one.
-
-If you try running `shopify` now, you should get a `command not found` error.
-
-> If you have the `shopify_api` gem installed, you may see the following response:
-> ```console
-> shopify command is no longer bundled with shopify_api.
-> if you need these tools, install the shopify_cli gem
-> ```
-> 
-> If so, then you will also need to upgrade the `shopify_api` gem to v9.2.0+ to remove a deprecated `shopify` command that is contained in that gem.
->
-> If you also have the `shopify_app` gem (which depends on `shopify_api` gem), you'll need to install or update `shopify_api` first, then uninstall the older version.
-> 
-> To get a list of the version(s) of `shopify_api` currently installed:
-> ```console
-> $ gem list shopify_api
-> ```
-> 
-> To install the latest version:
-> ```console
-> $ gem install shopify_api
-> ```
-> 
-> To uninstall the older version:
-> ```console
-> $ gem uninstall shopify_api -v x.y.z
-> ```
-> Replace x.y.z with a version number listed from the `gem list` command.  Repeat as needed.
-
-## 2. Install the new version
-
-Next, install the most recent version of Shopify App CLI. Follow the [install directions]({{ site.baseurl }}/getting-started/install/) for your platform.
-
-## 3. Re-authenticate the CLI
-
-The migration process moves some configuration files, so you’ll need to re-authenticate the CLI with your Shopify Partner Dashboard. The CLI will automatically prompt you to re-authenticate when needed.
-

data/docs/getting-started/uninstall/index.md

@@ -1,37 +1,4 @@
 ---
-title: Uninstall Shopify App CLI
-section: getting-started
-toc: false
-redirect_from: "/uninstall/"
+title: Troubleshooting Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/troubleshooting
 ---
-
-Shopify App CLI can be removed from your system using the same package manager you used to install it.
-
-### Homebrew (macOS)
-
-```console
-$ brew uninstall shopify-cli
-```
-
-### apt (Debian, Ubuntu)
-
-```console
-$ sudo apt remove shopify-cli
-```
-
-### yum (CentOS 8+, Fedora, Red Hat, SUSE)
-
-```console
-$ sudo yum remove shopify-cli
-```
-
-### RubyGems (macOS, Linux, Windows 10)
-
-```console
-$ gem uninstall shopify-cli
-```
-
-## Uninstall a legacy version
-
-If you’re using a legacy version of the CLI (`<0.9.0`), you’ll need to [uninstall it manually]({{ site.baseurl }}/getting-started/migrate/#1-uninstall-the-old-cli).
-

data/docs/getting-started/upgrade/index.md

@@ -1,41 +1,4 @@
 ---
-title: Upgrade Shopify App CLI
-section: getting-started
-toc: false
-redirect_from: "/upgrade/"
+title: Troubleshooting Shopify App CLI
+redirect_to: https://shopify.dev/tools/cli/troubleshooting
 ---
-
-You can manage upgrades to Shopify App CLI with the package manager for your platform.  **Note** that it's important to use the same package manager to upgrade that you originally used to install Shopify App CLI.
-
-### Homebrew (macOS)
-
-```console
-$ brew update
-$ brew upgrade shopify-cli
-```
-
-### apt (Debian, Ubuntu)
-
-On Debian-based Linux distributions, download the latest `.deb` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
-
-1. Download the `.deb` file from the [releases page](https://github.com/Shopify/shopify-app-cli/releases)
-1. Install the downloaded file
-```console
-$ sudo apt install /path/to/downloaded/shopify-cli-x.y.z.deb
-```
-
-### yum (CentOS 8+, Fedora, Red Hat, SUSE)
-
-On Red Hat–based Linux distributions, download the latest `.rpm` file for Shopify App CLI from the [releases page](https://github.com/Shopify/shopify-app-cli/releases) and install it to update.
-
-1. Download the `.rpm` file from the [releases page](https://github.com/Shopify/shopify-app-cli/releases)
-1. Install the downloaded file
-```console
-$ sudo yum install /path/to/downloaded/shopify-cli-x.y.x.rpm
-```
-
-### RubyGems (macOS, Linux, Windows 10)
-
-```console
-$ gem update shopify-cli
-```