https://github.com/javascript-studio/studio-cli
🎮 The JavaScript Studio CLI – Scan JavaScript sources for runtime errors
https://github.com/javascript-studio/studio-cli
analysis errors exceptions report runtime
Last synced: 5 months ago
JSON representation
🎮 The JavaScript Studio CLI – Scan JavaScript sources for runtime errors
- Host: GitHub
- URL: https://github.com/javascript-studio/studio-cli
- Owner: javascript-studio
- License: mit
- Created: 2017-01-10T14:20:36.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-14T11:10:25.000Z (over 7 years ago)
- Last Synced: 2025-03-27T15:51:54.414Z (9 months ago)
- Topics: analysis, errors, exceptions, report, runtime
- Language: JavaScript
- Homepage: https://javascript.studio
- Size: 115 KB
- Stars: 25
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE
Awesome Lists containing this project
README
# Studio CLI
JavaScript Studio is a cloud service that finds errors in JavaScript programs
by dynamically evaluating the source code in a custom runtime. If you do not
have an account, log in with GitHub at .
This command line tool encrypts and uploads source code to the [JavaScript
Studio][1] web service, fetches the error report and prints the results.
## Install
```bash
npm install @studio/cli -g
```
## Configuration
The CLI will try to load a configuration file in these locations:
- `.studio` in the current directory
- `.studio` in your home directory
- `$XDG_CONFIG_HOME/studio`
- `.config/studio` in your home directory
Copy your personal configuration from into
your preferred location. Never check this file into version control.
### Environment variables
The access token and the encryption secret can also be specified via
environment variables:
- `STUDIO_TOKEN`: Your access token.
- `STUDIO_SECRET`: Your encryption secret.
Environment variables take precedence over configured values. If `STUDIO_TOKEN`
is defined, the `.studio` file is optional.
### Available options
These properties can be configured:
- `token`: Your access token (required).
- `secret`: Your encryption secret. If provided, uploads are encrypted.
- `api`: The API endpoint to use. Defaults to
`https://api.javascript.studio/beta`.
## Usage
Run `studio --help` for all available options. A usage guide can be found at
.
## Related modules
- 📡 [Studio JSON Request][2] is used for API calls.
- 👻 [Studio Log][3] is used for logging.
- 📦 [Studio Changes][4] is used to create the changelog for this module.
## License
MIT
Made with ❤️ on 🌍
[1]: https://javascript.studio
[2]: https://github.com/javascript-studio/studio-json-request
[3]: https://github.com/javascript-studio/studio-log
[4]: https://github.com/javascript-studio/studio-changes