docs(agoric-cli): add agoric run; deprecate beta features #904
Conversation
- CLI Commands -> CLI Reference - prune initial "in this order" section in favor of list from `agoric help` - agoric run: brief usage; cite writeCoreProposals discussion - init: deprecate in favor of `yarn create @agoric/dapp` - Syntax -> Usage - markdown lint: `-` rather than `*` for lists; `_` rather than `*` for italic - install: deprecate This is supposed to be able to install from npm. I thought `agoric install agoric-upgrade-11wf` was supposed to do it, but I got an endless series of questions about what versions to use. If we have a form that's tested in ci, I'm not aware of it. Until we do, let's deprecate this. - start local-chain: document briefly - start: deprecate as beta feature - deploy: deprecate as beta feature - open: deprecate as beta feature
| ## ~~agoric install~~ | ||
|
|
||
| _Deprecated_ |
There was a problem hiding this comment.
agoric install can still be used to change the NPM versions of the sdk packages. Maybe we should rename it "agoric update", but that's an sdk change (which could be combined with a resolutions mechanism for endo). @michaelfig thoughts?
There was a problem hiding this comment.
agoric installcan still be used to change the NPM versions of the sdk packages.
I'm not clear on what that means. Care to sketch a sentence or two of documentation?
We don't have a test for this feature, by chance, do we?
There was a problem hiding this comment.
agoric install <npmtag> is definitely tested and used in tests. It updates all the known agoric dependencies to that npm tag. However I think the functionality is currently overloaded, and it's likely acceptable to not advertise it until we have a more complete story, which also handles the issues of version tearing we've noticed with endo packages.
| ## agoric init | ||
| ## ~~agoric init~~ | ||
|
|
||
| _Deprecated in favor of [yarn create @agoric/dapp](../getting-started/#creating-your-dapp-from-a-template)_ |
There was a problem hiding this comment.
I don't know the right verbiage, but it may be worthwhile to say something like:
| _Deprecated in favor of [yarn create @agoric/dapp](../getting-started/#creating-your-dapp-from-a-template)_ | |
| _Internal implementation for the preferred [yarn create @agoric/dapp](../getting-started/#creating-your-dapp-from-a-template)_ |
if we removed agoric init, then the yarn create @agoric/dapp form would stop working.
There was a problem hiding this comment.
low priority comment:
I feel like as a dapp developer trying to use agoric docs to learn to write a contract/dapp and how to initialize a project, details of internals aren't important to understand. I'm in favor of deprecated.
Deploying with
|
| Latest commit: |
e33b360
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8d67d123.documentation-7tp.pages.dev |
| Branch Preview URL: | https://dc-agoric-run.documentation-7tp.pages.dev |
agoric runagoric runwithwriteCoreProposalalso includes:
these last 2 changes can be removed if we want to postpone that step.