https://github.com/armoghans-organization/ctf
A command-line shell utility for setting up and managing Capture The Flag (CTF)
https://github.com/armoghans-organization/ctf
capture-the-flag challenges ctf hacking security utility
Last synced: about 1 year ago
JSON representation
A command-line shell utility for setting up and managing Capture The Flag (CTF)
- Host: GitHub
- URL: https://github.com/armoghans-organization/ctf
- Owner: Armoghans-Organization
- License: mit
- Created: 2024-11-11T12:56:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-27T16:43:31.000Z (over 1 year ago)
- Last Synced: 2025-02-01T22:28:19.263Z (over 1 year ago)
- Topics: capture-the-flag, challenges, ctf, hacking, security, utility
- Language: JavaScript
- Homepage:
- Size: 308 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CTF Utility 🚀
[](https://github.com/Armoghans-Organization/ctf/actions/workflows/dependabot/dependabot-updates)
[](https://github.com/Armoghans-Organization/ctf/actions/workflows/node.js.yml)
[](https://github.com/Armoghans-Organization/ctf/blob/main/LICENSE)
A command-line shell utility for setting up and managing Capture The Flag (CTF) challenges.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Available Commands](#available-commands)
- [Scripts](#scripts)
- [Contributing](#contributing)
- [License](#license)
## Features
- Manage CTF challenges easily from the command line.
- Supports user and package management.
- Integrated with ESLint and Prettier for code quality and formatting.
- Configurable with GitHub Actions for CI/CD.
## Installation
To install the project, clone the repository and install the dependencies:
```bash
git clone https://github.com/Armoghans-Organization/ctf.git
cd ctf
npm install
```
## Usage
You can run the utility using the following command:
```bash
npx ctf
```
### Available Commands
- **Linting**: To check for code quality, run:
```bash
npm run lint
```
- **Formatting**: To format your code, run:
```bash
npm run format
```
- **Lint and Fix**: To lint and automatically fix issues, run:
```bash
npm run lint:fix
```
## Scripts
The following scripts are available in this project:
- `lint`: Runs ESLint on the project files.
- `format`: Formats the code using Prettier.
- `lint:fix`: Lints and automatically fixes issues.
## Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or features.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.