@gravityci/cli v0.0.2-alpha.15
@gravityci/cli
Run Gravity for a given set
filePath
patterns
Usage
Minimal usage
gravityci 'dist/**/*'
Multiple paths
gravityci 'dist/**/*' 'dist2/**/*' 'dist3/**/*' ...
Arguments
argument | type | description |
---|---|---|
<patterns> | array of strings | Required. File path patterns of the compiled files the user wants to check its bundlesize |
Running it in your Local Machine
Before running CLI
Before running Gravity's cli in your local machine make sure:
- All your dependencies have been installed.
package/cli
has been compiled (pnpm run build
) if you want to execute production version (pnpm run cli
)- All the necessary environment variables have been set in
packages/cli/.env
file:GRAVITY_TOKEN
: This is the token which will grant a user to interact with Gravity Server. If a user does not have a valid Gravity Token, the server won't let the user interact with it (upload a bundle, add a bundle analysis request to the queue, etc.)GRAVITY_HOST
: The host where the server is running. In localhost should behttp://localhost
or the host of the tunnel you could be using (seepackage/server
for more details).GRAVITY_PORT
: The port where the server is running. In localhost usually is3000
but can be any other port free of use you want to run your server locally. Just make sure the value matches the port used by@gravityci/server
.
- @gravityci/server is running and listening to the
$GRAVITY_HOST
and$GRAVITY_PORT
you set up in step 3.
Troubleshooting
gravity's cli
<patterns>
argument is evaluated from process.cwd()
, this means, the pattern
is applied from current working directory where the script is executed. The
filePath pattern
can use ../../
to navigate to parent directories.
Absolute paths are NOT supported for the moment.
Other common issues
For more general issues common across packages, don't forget to visit general Troubleshooting document
Contributing
See CONTRIBUTING.md
About Gravity
@gravity Gravity checks file sizes in your Pull Requests.
License
8 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago