@LizCouto suggested that we should have a small page on the docs mentioning basic info about the CLI (how to install, how to use, how to get help) for discoverability and marketing purposes, even if its some of the same content as the Github Pages site.

Will probably require a some form of "project" context so that the tool can be aware of what the command needs to run underneath.

Should generate example data on a given dev store.

• products
• collections
• customers
• orders

Would be good to provide an easy way for people to uninstall it, or maybe just instructions to do so.

Commands should be able to compose themselves from a group of smaller tasks, and specifying these tasks as a prerequisite for running should be simple, like:

class Command
  prerequsite_task :tunnel

  def call
    do_stuff
  end
end

see Technical Design.

shell infrastructure

• add coverage
• build in auto updates and update command
• solution for contributing/development like dev load-dev/dev canary.
• install in home directory instead of /opt/shopify-cli. Linux doesn't like world writable things there.
• add instructions for scripting. users should be able to do something like <shopify-cli-dir>/bin/shopify task foo bar from a script to automate business tasks.
• detect yarn or npm usage for a project. figure out what the default should be.
• build a nicer output for ugly tasks like yarn, whose output doesn't make much sense and 90% of the time isn't useful.

Similar to dev's dev load-dev/dev canary, the command will symlink the cloned copy of the CLI to the install destination.

shopify.dev/cli -> this README

move from app_type to create

Ask for shop name and cache

Retail Product Marketing and Retail Sales would love if this CLI could create orders across multiple sales channels (specifically POS) rather than just online to give a better sense of our platforms multi-channel capabilities.

When creating demo stores for sales/marketing purposes, there isn't an easy way for us to simulate the volume of POS orders across many locations that a merchant would typically see. We currently use the Shopify Developer Tools data generator to simulate data, but this only populates online orders, skewing information.

Please contact @brian for further information if necessary, thanks!

To match our command tree, the current create flow should be moved to as subcommand of create.

Examples:

• different ngrok binary URLs per OS

Should have two subcommands to allow a user to authenticate out-of-band from a task that requires auth:

• login
• whoami

If we can serialize all the help text into translated YAML we could probably provide a configuration setting for language and read from it based on that. I think command names and arguments will have to remain in English since these are defined in code and I think would be too confusing otherwise anyway.

In order to keep track of things that change from stack to stack we need to store some metadata by AppType in the users codebase. We'll generate a shopify-cli.yml that, for now, just contains an app_type: key to keep track of this. This will allow us to run the different commands for server, generate, etc based on the project's language/framework.

This also sets us up to allow users to override these behaviours in the future.

need to check for it and warn or install

dnewton@newtron-mbp ~/src/github.com/Shopify  👍  shopify create test-heroku-node
✓ Installing ngrok...
✔︎ ngrok tunnel running at https://6672b37c.ngrok.io
? What type of app would you like to create? (You chose: node embedded app)
┏━━ Cloning into test-heroku-node... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
┃                                                                                                                                        100%
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ (3.47s) ━━
┏━━ Installing dependencies with npm... ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ (0.0s) ━━
This command ran with ID: 35500
Please include this information in any issues/report along with relevant logs
Traceback (most recent call last):
	31: from /Users/dnewton/src/github.com/Shopify/shopify-cli/bin/shopify:36:in `<main>'
	30: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/error_handler.rb:20:in `call'
	29: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/error_handler.rb:74:in `handle_abort'
	28: from /Users/dnewton/src/github.com/Shopify/shopify-cli/bin/shopify:37:in `block in <main>'
	27: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/entry_point.rb:11:in `call'
	26: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/executor.rb:16:in `call'
	25: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:14:in `call'
	24: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:45:in `with_traps'
	23: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:57:in `twrap'
	22: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:46:in `block in with_traps'
	21: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:57:in `twrap'
	20: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:47:in `block (2 levels) in with_traps'
	19: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:15:in `block in call'
	18: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:37:in `with_logging'
	17: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-ui/lib/cli/ui.rb:143:in `log_output_to'
	16: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:38:in `block in with_logging'
	15: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-ui/lib/cli/ui/stdout_router.rb:164:in `with_id'
	14: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:39:in `block (2 levels) in with_logging'
	13: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/executor.rb:17:in `block (2 levels) in call'
	12: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/command.rb:14:in `call'
	11: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/commands/create.rb:23:in `call'
	10: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/app_type_registry.rb:11:in `build'
	 9: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/task.rb:7:in `call'
	 8: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/app_types.rb:24:in `call'
	 7: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/app_types/node.rb:38:in `build'
	 6: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/task.rb:7:in `call'
	 5: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/tasks/js_deps.rb:14:in `call'
	 4: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-ui/lib/cli/ui/frame.rb:82:in `open'
	 3: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/tasks/js_deps.rb:15:in `block in call'
	 2: from /Users/dnewton/src/github.com/Shopify/shopify-cli/lib/shopify-cli/tasks/js_deps.rb:29:in `install_progress'
	 1: from /Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/system.rb:114:in `system'
/Users/dnewton/src/github.com/Shopify/shopify-cli/vendor/deps/cli-kit/lib/cli/kit/system.rb:114:in `spawn': No such file or directory - npm (Errno::ENOENT)

Issue summary

How does handoff and sharing work?

If I make a PHP scaffold and need to share that with another partner, how do I do that?

More from Dave

1. app dev transfers app to someone else to work on (new team, or someone on same team). will the new dev be able to install shopify cli and start using it? i think this scenario is fine and doesn’t need work
2. same scenario, but the app dev has built a custom php app scaffolder that they’ve integrated into shopify app cli and used this to scaffold their app. new dev needs this php thing. what’s the process for sharing here? create a fork? create a branch? have some sort of plugin system?
3. same scenario as 2, but not sharing an app. dev who created php scaffold wants to share it with another dev to start a new project.

• make it work
• refactor PIDFile/Logger out of task
• [ ] make it work cross platform #68
• add other implementations other than ngrok

Aws-express-serverless example: https://github.com/awslabs/aws-serverless-express
Serverless-http: handler that lets you use koa, express and others in a serverless environment

Currently this task swallows clone errors, it should display them to the user.

Ability to generate code for a new "page" in an app

In create command we need to keep versioning consistent .

After discussion and discovery we've determined that many of our tasks require interaction with the Admin API directly, such as consuming the GraphQL schema to generate code for webhooks and creating example shop data on a dev store. In order to do we need an access token.

Our MVP implementation for this will be to deploy a simple web app that the CLI will open before these tasks and ask the user to install it on their dev shop. After authentication we will display an access token in a copyable text field to paste back into the CLI. The CLI will cache the token on disk and use it to make requests to the Admin API.

Currently we prompt for api key and secret on create but CLI::Prompt prints this back out. We should try to ****** it out like in the Partners Dash

• An update command that pulls the CLI source from github.
• A configuration option to opt in to auto updates

Should create a dev store (or "test store", if available) on a partners account and install the current app on it

rm <> see David's doc

Add a global configuration mechanism to track user preferences across projects, such as auto-updating of the CLI.

Should auth with Partners as necessary and insert credentials into current project and install onto dev store.

Green container for next steps
Containers for things we swallow
etc

Currently this command class consolidates too much logic.

Things to isolate:

• app types should be individual classes placed into a registry like Commands and Tasks
• repository cloning should be moved to its own task #7
• env file construction should be moved to its own task #22
• yarn should be moved to its own task

These are the most common charges:

1. Recurring charges, with and without trials
2. Usage charges that are posted daily, or even per usage (can include a $0 monthly fee or more)
3. Usage charges that are posted at the end of the billing cycle (we don’t usually recommend this, though)
4. OneTime charges for actual one-time purchases
5. OneTime charges for annual billing

We'll need to do all the things https://development.shopify.io/engineering/dev_culture/open_source mentions before we make this repo public.

Still to do -
Make app public
Add to open source directory

When the CLI launches to the public, we should update the Build an App tutorial with callouts to use the tool when it can replace manual work.

• Set up your app
• Billing
• any others?