Add a new `scaffold` command to the CLI #34

jakedahn · 2023-11-17T04:10:17Z

This PR introduces a new scaffold command to the Replicate CLI.

You can use this command to bootstrap a completely functional development environment from a given prediction ID or URL.

To start, support is limited to javascript via the https://github.com/replicate/node-starter repo and python via the https://github.com/replicate/python-starter repo.

Usage

Scaffold via prediction URL

replicate scaffold https://replicate.com/p/z5kvo4tb6mhb7xnpxpjpfxlzxe /path/to/repo (default uses node)
replicate scaffold --template node https://replicate.com/p/z5kvo4tb6mhb7xnpxpjpfxlzxe /path/to/repo (node)
replicate scaffold --template python https://replicate.com/p/z5kvo4tb6mhb7xnpxpjpfxlzxe /path/to/repo (python)

Scaffold via prediction ID

replicate scaffold z5kvo4tb6mhb7xnpxpjpfxlzxe /path/to/repo (default uses node)
replicate scaffold --template node z5kvo4tb6mhb7xnpxpjpfxlzxe /path/to/repo (node)
replicate scaffold --template python z5kvo4tb6mhb7xnpxpjpfxlzxe /path/to/repo (python)

`replicate clone --template node [prediction] [output path]` `replicate clone --template python [prediction] [output path]`

zeke · 2023-11-17T07:12:44Z

Should we also support this other format of prediction URL?

https://replicate.com/stability-ai/stable-diffusion?prediction=emeqxllb6c4uxjy2dbun6yk62u

mattt

This is great, @jakedahn. Thank you so much for working on this. I left some specific code review suggestions for your consideration.

Some more high-level feedback:

I'm not sure clone is the right spelling for this command. I slightly prefer scaffold, but maybe there's another option bootstrap? project init?
- If project init, then maybe the prediction is optional, and you just use a default example, like SDXL.
Looking what's in the starter repos, I think it might make sense to embed them in the CLI itself. Go has a nice affordance for embedding source files as string constants to make that convenient.
- If the concern is future-proofing, then we could put the template files in the CLI repo and fetch the latest versions.

internal/cmd/clone/root.go

mattt · 2023-11-17T10:58:40Z

internal/cmd/clone/root.go

+	// Run the example prediction
+	fmt.Println("Running example prediction...")
+	commands = []string{
+		fmt.Sprintf("cd %s && node prediction.py", outputClonePath),
+	}
+	for _, command := range commands {
+		cmd := exec.Command("bash", "-c", command)
+		cmd.Stdout = os.Stdout
+		cmd.Stderr = os.Stderr
+		err := cmd.Run()
+		if err != nil {
+			return err
+		}
+	}


I find this last step of running the prediction to be unexpected. Instead, I think we should print the output path and provide instructions for what to do next.

@jakedahn Any objections to skipping this last step?

bfirsh · 2023-11-17T14:52:39Z

Agreed clone feels a bit funny. Not sure why. Perhaps because it's a bit of a different intent from Git? Perhaps because having it as a top-level command implies it's a primary action of Replicate the product? Run, models, deployments... clone?

init is a pattern we have in Cog. Scaffold and bootstrap both seem pretty good too. No strong feelings overall.

…e optional argument, and change to kebab case. Co-authored-by: Mattt <mattt@replicate.com>

Co-authored-by: Mattt <mattt@replicate.com>

…default name should be generated based on the prediction ID Co-authored-by: Mattt <mattt@replicate.com>

Co-authored-by: Mattt <mattt@replicate.com>

…ring

zeke · 2023-11-17T20:17:23Z

Looking what's in the starter repos, I think it might make sense to embed them in the CLI itself.

I tend to agree.

jakedahn · 2023-11-17T20:25:38Z

Looking what's in the starter repos, I think it might make sense to embed them in the CLI itself.

I tend to agree.

I disagree here.

The hope behind using actual git repos here is that in a future iteration, someone could say replicate init --template https://github.com/cbh123/replicate-elixir.git <prediction id> /path/to/checkout. Allowing anybody the ability to create their own starter templates that hook into the same cli.

I think it's a strange experience to be like "oh I would really love to add a starter template for elixir", and then be forced to vendor everything inside of a golang codebase where it never gets updated because doing so inside of a golang codebase feels foreign.

This pattern is not implemented in this PR as-is, but this is a future I think is worth heading towards.

jakedahn · 2023-11-17T21:27:46Z

I've renamed everything to replicate init 🙌

mattt · 2023-11-19T13:55:40Z

The hope behind using actual git repos here is that in a future iteration, someone could say replicate init --template https://github.com/cbh123/replicate-elixir.git <prediction id> /path/to/checkout. Allowing anybody the ability to create their own starter templates that hook into the same cli.

@jakedahn 100% with you. We can get the best of both worlds by locating built-in templates (python, node) in CLI repo, and eventually allowing user-provided URLs to repos.

You could even implement this internally by routing aliases like python to the full path in the CLI repo on GitHub. You'd just need to support paths to subdirectories.

mattt · 2023-11-20T12:15:24Z

@jakedahn Thanks again for your great work on this. I'm excited to have this in the CLI.

I was thinking about this some more the other day, and came up with a slightly different interface:

# Generate from a prediction
replicate prediction scaffold z5kvo4tb6mhb7xnpxpjpfxlzxe # also supports URLs


# Generate from a model's default example
replicate model scaffold stability-ai/sdxl # also supports URLs, optional version


# Top-level alias that automatically does the right thing
replicate scaffold z5kvo4tb6mhb7xnpxpjpfxlzxe # prediction ID
replicate scaffold stability-ai/sdxl # model name
replicate scaffold # default project template

In the interest of shipping fast and iterating, the minimal change would be to rename init to scaffold. From there, we could fill in the respective subcommands and update the top-level command to support no argument and a model argument.

How does that sound?

Introducing a new "clone" command to the CLI

be19f4b

`replicate clone --template node [prediction] [output path]` `replicate clone --template python [prediction] [output path]`

jakedahn requested a review from mattt November 17, 2023 04:10

linter fixes

c4bf980

mattt reviewed Nov 17, 2023

View reviewed changes

jakedahn and others added 10 commits November 17, 2023 09:16

Use angle brackets to denote placeholders, square brackets to indicat…

0f34979

…e optional argument, and change to kebab case. Co-authored-by: Mattt <mattt@replicate.com>

Make directory argument optional.

90e1c0f

Co-authored-by: Mattt <mattt@replicate.com>

The output directory should be an optional argument. When omitted, a …

7607ff1

…default name should be generated based on the prediction ID Co-authored-by: Mattt <mattt@replicate.com>

simplify command error handling

4bbc3fd

Co-authored-by: Mattt <mattt@replicate.com>

Prefer HTTPS to Git

651a4f9

Co-authored-by: Mattt <mattt@replicate.com>

Run in context of command and use /bin/sh

4abead2

Co-authored-by: Mattt <mattt@replicate.com>

switch instead of if tree

1960e51

Co-authored-by: Mattt <mattt@replicate.com>

Improved prediction id parsing

9b8c515

Co-authored-by: Mattt <mattt@replicate.com>

fixing minor issues

92c55ec

cleaning up the functions to use cmd context, not passing in model st…

d5ab886

…ring

jakedahn added 2 commits November 17, 2023 14:10

significant cleanups

cd93fe9

renaming to init

6ddd55e

mattt added 8 commits November 19, 2023 08:56

Merge branch 'main' into replicate-clone

23a93ad

Rename shellCommand to execCommand, take ctx argument, check errors

7b0f84f

Fix linting errors

8b8e299

Update variable names and comments

b274ac6

Support node, nodejs, js as values for Node.js

a248f31

Return errors instead of doing os.Exit

2f7e08f

Refactor handling of REPLICATE_API_TOKEN environment variable

0246d84

Return errors instead of printing them and continuing

2df0601

Rename init_cmd -> initCmd

2103cf3

Rename init to scaffold

c684268

mattt changed the title ~~Adding a new clone command to the CLI~~ Add a new scaffold command to the CLI Nov 20, 2023

Move scaffold command to cmd package

0b6e2f8

mattt merged commit c2aa540 into main Nov 20, 2023

mattt deleted the replicate-clone branch November 20, 2023 22:30

Add a new scaffold command to the CLI #34

Add a new scaffold command to the CLI #34

Uh oh!

Conversation

jakedahn commented Nov 17, 2023 • edited by mattt Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Usage

Uh oh!

zeke commented Nov 17, 2023

Uh oh!

mattt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mattt Nov 17, 2023

Choose a reason for hiding this comment

Uh oh!

mattt Nov 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bfirsh commented Nov 17, 2023

Uh oh!

zeke commented Nov 17, 2023

Uh oh!

jakedahn commented Nov 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jakedahn commented Nov 17, 2023

Uh oh!

mattt commented Nov 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mattt commented Nov 20, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Add a new `scaffold` command to the CLI #34

Add a new `scaffold` command to the CLI #34

jakedahn commented Nov 17, 2023 •

edited by mattt

Loading

mattt Nov 19, 2023 •

edited

Loading

jakedahn commented Nov 17, 2023 •

edited

Loading

mattt commented Nov 19, 2023 •

edited

Loading