-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial release with bash-completion and API commands. Supports configuration using CLI flags, environment variables, or YAML/JSON files. - Initial project boilerplate (docs, license, contributing, etc) - Bash completion is via the `bash-completion` command Added the following commands that interact with the Signal Sciences API: - get-corp - list-agents - list-corps - list-suspicious-ips - list-top-attacks
- Loading branch information
0 parents
commit 4e2c610
Showing
18 changed files
with
1,450 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* timoguin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
sigcli |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
||
## [Unreleased] | ||
|
||
<!-- | ||
Any notes about merges to master that haven't been added to a Git tag should go | ||
here. When it's time to cut a new release, create a header for the new version | ||
below and move the content of this section down to the new version. | ||
### Added | ||
If you add any new code or functionality, document your changes here. | ||
### Changed | ||
If you change any existing code or functionality, document your changes here. | ||
### Removed | ||
If you remove any existing code or functionality, document your changes here. | ||
--> | ||
|
||
Upcoming release | ||
|
||
### Added | ||
|
||
### Changed | ||
|
||
### Removed | ||
|
||
## [0.1.0] | ||
|
||
Initial release with bash-completion and API commands. Supports configuration | ||
using CLI flags, environment variables, or YAML/JSON files. | ||
|
||
### Added | ||
|
||
- Initial project boilerplate (docs, license, contributing, etc) | ||
- Bash completion is via the `bash-completion` command | ||
|
||
Added the following commands that interact with the Signal Sciences API: | ||
|
||
- get-corp | ||
- list-agents | ||
- list-corps | ||
- list-suspicious-ips | ||
- list-top-attacks | ||
|
||
<!-- | ||
This section should be updated with every release. It contains a sequence of | ||
links to GitHub that show the full Git diff between each release. The brackets | ||
allow us to render the version headers as links by adding brackets to any | ||
matching headers. Any commits that don't yet belong to a Git tag will show the | ||
Git diff from the last tag to the master branch HEAD. | ||
--> | ||
[Unreleased]: https://github.com/timoguin/sigcli/compare/v0.1.0..HEAD | ||
[0.1.0]: https://github.com/timoguin/sigcli/tree/v0.1.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team at [email protected]. All | ||
complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish | ||
to make via issue, email, or any other method with the owners of this | ||
repository before making a change. | ||
|
||
## Issue Tracking | ||
|
||
Issues can be tracked via GitHub issues. | ||
|
||
## Pull Request Process | ||
|
||
We encourage a fork-based workflow, where experimental branches will live in | ||
your fork until they're ready to be submitted upstream via a PR. | ||
|
||
1. Fork this repository. | ||
2. Create a new branch of off master for your work. | ||
3. Update the [README](README.md) to document your change [README driven development!](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html). | ||
4. Update or add a breaking test for your change. | ||
5. Add your change until the tests pass. | ||
6. Add a note about your change to the _Unreleased_ section of the [CHANGELOG](CHANGELOG.md). | ||
7. Squash or rebase your commits. | ||
8. Create a PR back to the master branch of this repo. | ||
9. The repo CODEOWNERS will be tagged for PR review. | ||
10. Once your change is approved, your PR will be merged. | ||
11. When maintainers create a new release, your CHANGELOG entry will be moved | ||
from Unrelease to the section for the new version. | ||
12. You've done it! |
Oops, something went wrong.