breadboard-ai / breadboard

A library for prototyping generative AI applications.
Apache License 2.0
160 stars 22 forks source link

brand new users will be unable to use the `init` commands #674

Open Mearman opened 7 months ago

Mearman commented 7 months ago

In part of my simulating onboarding a brand new first-time user (related to https://github.com/breadboard-ai/breadboard/issues/633 and https://github.com/breadboard-ai/breadboard/pull/667 ), I discovered that if a user hasn't already installed the namespaced @google-labs packages, npm init breadboard and npm init breadboard-kit won't function.

When npm init X is called it maps to npm exec create-X. So for a first-time user:

I have published empty packages for create-breadboard and create-breadboard-kit to reserve them for the project:

As a solution. I propose mirroring the @google-labs/create-breadboard and @google-labs/create-breadboard-kit.

For npm exec breadboard unfortunately, there is an apparently long-dead project at https://www.npmjs.com/package/breadboard so npx breadboard will resolve to that, however as an alternative, I have reserved breadboard-cli

PaulKinlan commented 7 months ago

Isn't it npm init @google-labs/breadboard?

PaulKinlan commented 7 months ago

and to get breadboard command working, then you should just be able to npm -g -i @google-labs/breadboard-cli and it will alias breadboard so you don't have to think about npx breadboard...

npx breadboard is really just for our local repo