yage
fec8c5e560
introduce --verbosity flag rather than mixed logging settings; correct color misnaming to ANSI convention; added sanity-check; simplified hello-world; created FZF_USER_INPUT to replace the confusing FZF_HEAD and FZF_TAIL swap INFO for DEBUG v3-to-v4 upgrade docs bring some much-needed tender love and care to the scwrypts runner improved i/o handling on the run executable means this is no longer relevant FINALLY fix the weird cases for zsh/read builtin (particularly around reading one character from tty/pipe/file); also gave a --force-user-input flag in case you want to require user input on a yn prompt update ZLE plugin so it no more make errors FZF_(HEAD|TAIL) refactor to FZF_USER_INPUT plugins/kubectl migration from v3 to v4 plugins/ci migration from v3 to v4 refactor py/lib into python-scwrypts subproject verbosity is stupid lets call it log-level fix bug with virtualenv loading mergedeep to slow so I made my options dict shallow hokay first iteration of python-dudes is ready circleci configuration for python builds npm package for scwrypts 3.9.1 initial build/test steps for nodejs go go ok ok fix output ok ok finalize publish steps
61 lines
3.1 KiB
Markdown
61 lines
3.1 KiB
Markdown
# *Scwrypts* (Wryn + Scripts)
|
|
|
|
Scwrypts is a friendly CLI / API for quickly running *sandboxed scripts* in the terminal.
|
|
|
|
In modern developer / dev-ops workflows, scripts require a complex configurations.
|
|
Without a better solution, the developer is cursed to copy lines-upon-lines of variables into terminals, create random text artifacts, or maybe even commit secure credentials into source.
|
|
Scwrypts leverages ZSH to give hot-key access to run scripts in such environments.
|
|
|
|
## Major Version Upgrade Notice
|
|
|
|
Please refer to [Version 3 to Version 4 Upgrade Path](./docs/upgrade/v3-to-v4.md) when upgrading from scwrypts v3 to scwrypts v4!
|
|
|
|
## Dependencies
|
|
Due to the wide variety of resources used by scripting libraries, the user is expected to manually resolve dependencies.
|
|
Dependencies are lazy-loaded, and more information can be found by command error messages or in the appropriate README.
|
|
|
|
Because Scwrypts relies on Scwrypts (see [Meta Scwrypts](./zsh/scwrypts)), `zsh` must be installed and [`junegunn/fzf`](https://github.com/junegunn/fzf) must be available on your PATH.
|
|
|
|
## Usage
|
|
Install Scwrypts by cloning this repository and sourcing `scwrypts.plugin.zsh` in your `zshrc`.
|
|
You can now run Scwrypts using the ZLE hotkey bound to `SCWRYPTS_SHORTCUT` (default `CTRL + W`).
|
|
|
|
```console
|
|
% cd <path-to-cloned-repo>
|
|
% echo "source $(pwd)/scwrypts.plugin.zsh >> $HOME/.zshrc"
|
|
```
|
|
|
|
Check out [Meta Scwrypts](./zsh/scwrypts) to quickly set up environments and adjust configuration.
|
|
|
|
|
|
### No Install / API Usage
|
|
Alternatively, the `scwrypts` API can be used directly:
|
|
```zsh
|
|
./scwrypts [--env environment-name] (...script-name-patterns...) [-- ...passthrough arguments... ]
|
|
```
|
|
|
|
Given one or more script patterns, Scwrypts will filter the commands by pattern conjunction.
|
|
If only one command is found which matches the pattern(s), it will immediately begin execution.
|
|
If multiple commands match, the user will be prompted to select from the filtered list.
|
|
Of course, if no commands match, Scwrypts will exit with an error.
|
|
|
|
Given no script patterns, Scwrypts becomes an interactive CLI, prompting the user to select a command.
|
|
|
|
After determining which script to run, if no environment has been specified, Scwrypts prompts the user to choose one.
|
|
|
|
|
|
### Using in CI/CD or Automated Workflows
|
|
Set environment variable `CI=true` (and use the no install method) to run in an automated pipeline.
|
|
There are a few notable changes to this runtime:
|
|
- **The Scwrypts sandbox environment will not load.** All variables will be read from context.
|
|
- User yes/no prompts will **always be YES**
|
|
- Other user input will default to an empty string
|
|
- Logs will not be captured
|
|
- Setting the environment variable `SCWRYPTS_GROUP_LOADER__[a-z_]\+` will source the file indicated in the variable (this allows custom groups without needing to modify the `config.zsh` directly)
|
|
- In GitHub actions, `*.scwrypts.zsh` groups are detected automatically from the `$GITHUB_WORKSPACE`; set `SCWRYPTS_GITHUB_NO_AUTOLOAD=true` to disable
|
|
|
|
|
|
## Contributing
|
|
|
|
Before contributing an issue, idea, or pull request, check out the [super-brief contributing guide](./docs/CONTRIBUTING.md)
|