README
CodePass CLI
:point_right: Sign up for CodePass, the Quickest Way To Solve Your Coding Errors! :boom:
Solutions | History |
---|---|
Installation
With npm:
npm install --global @codepass/cli
Or with Yarn:
yarn global add @codepass/cli
Getting Started
Initialize your user and project configuration by running:
codepass init
Sending Problems
See usage examples by running:
codepass problem --help
Commands
See all of the available commands by running:
codepass --help
Configuration
You can customize CodePass with the appropriate .codepassrc.yml
file:
- Personal / global configuration:
~/.codepassrc.yml
, in user's home directory - Project specific configuration:
.codepassrc.yml
in project root
Note: Array values are concatinated if specified in both personal and project configuration files.
Security
Security is important to us.
You can customize the data you're sending to CodePass by editing your .codepassrc.yml
file.
Environment Variables
You can hide values for environment variables by setting security.hidden.env
to an array of strings in your configuration files.
For example:
security:
hidden:
env:
- AWS_ACCESS_KEY_ID
- AWS_SECRET_ACCESS_KEY
- HOMEBREW_GITHUB_API_TOKEN
The existance of the environment variable will still be sent, however, the actual value will not be sent and instead be shown as HOMEBREW_GITHUB_API_TOKEN
below:
Before sending your data to CodePass you will be given another and final opportunity to hide your environment variables with the interactive CLI: