github/meteor
1
1
Fork 0
mirror of https://github.com/meteor/meteor.git synced 2026-05-02 03:01:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

help for many of the new commands

Browse Source
This commit is contained in:
ekatek
2014-06-15 18:39:02 -07:00
parent 9244e13626
commit 012a27fd87
2 changed files with 116 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

155
tools/help.txt
View File

@@ -47,17 +47,23 @@ Create a new project
Usage: meteor create [--release <release>] <name>
meteor create [--release <release>] --example <example_name> [<name>]
meteor create --list
meteor create --package [<package_name>]
Make a subdirectory named <name> and create a new Meteor project
there. You can also pass an absolute or relative path.
there. If the package option is specified, creates a meteor package,
otherwise creates a meteor app. You can also pass an absolute or relative path.
The project will use the release of Meteor specified with the --release
option, or the latest available version if the option is not specified.
The app will use the release of Meteor specified with the --release
option, or the latest available version if the option is not specified. (A
package created in an app, will be created using the application's version of
meteor and a package created outside a meteor app will use the latest release).
You can pass --example to start off with a copy of one of the Meteor
sample applications. Use --list to see the available examples.
sample applications. Use --list to see the available examples. There are currently
no package examples.
Options:
--package Create a new meteor package instead of an app.
--example Example template to use.
--list Show list of available examples.
@@ -70,6 +76,7 @@ Sets the version of Meteor to use with the current project. If a
release is specified with --release, set the project to use that
version. Otherwise download and use the latest release of Meteor.
XXX: change to new world order
>>> run-upgrader
Execute a specific upgrader by name. Intended for testing.
@@ -84,8 +91,8 @@ Add a package to this project
Usage: meteor add <package> [package] [package..]
Adds packages to your Meteor project. You can add multiple
packages with one command. For a list of the available packages, see
'meteor list'.
packages with one command. To query for available packages, use
the meteor --search command.
>>> remove
@@ -94,18 +101,15 @@ Usage: meteor remove <package> [package] [package..]
Removes a package previously added to your Meteor project. For a
list of the packages that your application is currently using, see
'meteor list --using'.
'meteor list'.
>>> list
List available packages
Usage: meteor list [--using]
Without arguments, lists all available Meteor packages. To add one
of these packages to your project, see 'meteor add'.
With --using, list the packages that you have added to your project.
List the packages explicitly used by your project.
Usage: meteor list
List the packages that you have explicitly added to your project.
This will not list transitive dependencies.
>>> bundle
Pack this project up into a tarball
@@ -278,20 +282,6 @@ Options:
--settings Set optional data for Meteor.settings on the server
>>> rebuild-all
Rebuild all packages
Usage: meteor rebuild-all
Rebuild all local packages. This includes packages found through the
PACKAGE_DIRS environment variable, local packages in the current
application, and, if running Meteor from a checkout, the packages in
the checkout. It doesn't include any packages for which we don't have
the source.
You should never need to use this command. It is intended for use while
debugging the Meteor packaging tools themselves.
>>> self-test
Run tests of the 'meteor' tool.
Usage: meteor self-test [pattern] [--changed] [--slow]
@@ -349,14 +339,6 @@ Options:
--changed A boolean option.
>>> publish
Publish a new version of a package to the package server
Usage: meteor publish [--create]
Pass --create to create a new package.
>>> list-sites
List sites for which you are authorized
Usage: meteor list-sites
@@ -365,11 +347,104 @@ List the sites that you have deployed with 'meteor deploy', and sites
for which other users have authorized you with the 'meteor authorized'
command.
>>> publish-release
Publish a new release
Usage: meteor publish-release <release.json>
Publish a new release.
>>> publish-release
Publish a new meteor release to the package server
Usage: meteor publish-release <path to json config> [--create-track]
Publishes a new release to the package server, as determined by the json
configuration file, which must have the following keys:
track: the release track to which you are publishing (ex: METEOR-CORE)
version: the version of this release
recommended: is this a recommended release? (see below)
description: a brief description of the release
tool: <package name>@<version> of the meteor tool that this release specifies
packages: object of <package name> to <version> for specified package versions
Set the recommended flag to true for recommended releases (ex: METEOR-CORE@0.90)
and false for release candidates, experimental releases, etc. You must publish
all package versions to the package server before you can specify them in a
release.
Use the --create-track to publish a new release track.
Options:
--create-track publish a new release track.
>>> publish
Publish a new version of a package to the package server
Usage: meteor publish [--create]
Publishes a new version of a local package to the package server. Must be run
from the directory containing the package. Reads the package.js file for version
information, builds the package and sends both the package source and the built
version of the package to the package server.
This will only create one build of the package. If your package has multiple
builds for different OS architectures, it will create a build for this machine's
architecture. To publish a different build for the same version, run
publish-for-arch.
This will mark you as the only maintainer of the package. If you need to change
maintainers and other metadata about this package & package version, take a look
at the admin commands.
Pass --create to create a new package.
Options:
--create publish a new package
>>> publish-for-arch
XXX: WRITE
>>> rebuild
Rebuild local packages
Usage: meteor rebuild [<package name>]
Rebuild a specified local packages. Deletes the package's build directory
and rebuilds the package from scratch. Please specify the package by name.
If you pass no arguments, this will rebuild all local packages.
That includes packages found through the
PACKAGE_DIRS environment variable, local packages in the current
application, and, if running Meteor from a checkout, the packages in
the checkout. It doesn't include any packages for which we don't have
the source.
You should never need to use this command. It is intended for use while
debugging the Meteor packaging tools themselves.
>>> search
Search through the package server database.
Usage: meteor search <string>
meteor search --details <package or release name>
Search through the meteor package&release database for names containing the
specified substring.
Use --details to get detailed information on a specific package or release.
Options:
--details show detailed information on a specific package or release
>>admin maintainers
XXX: WRITE
>>admin recommend-release
XXX: WRITE
>>admin change-package-url
XXX: WRITE
>>admin set-earliest-compatible-version
XXX: WRITE (after glasser is done)

2
tools/package-client.js
View File

@@ -457,7 +457,7 @@ exports.publishPackage = function (packageSource, compileResult, conn, options)
var packRecord = catalog.official.getPackage(name);
if (!packRecord) {
process.stderr.write('There is no package named ' + name +
'. If you are creating a new package, use the --create-track flag. \n');
'. If you are creating a new package, use the --create flag. \n');
process.stderr.write("Publish failed. \n");
return 1;
}