Skip to content

A command-line shell utility for setting up and managing Capture The Flag (CTF)

License

Notifications You must be signed in to change notification settings

Armoghans-Organization/ctf

Repository files navigation

CTF Utility 🚀


Dependabot Updates Node.js Package Test 🎉 GitHub code-size

A command-line shell utility for setting up and managing Capture The Flag (CTF) challenges.

Table of Contents

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:

git clone https://github.com/Armoghans-Organization/ctf.git
cd ctf
npm install

Usage

You can run the utility using the following command:

npx ctf

Available Commands

  • Linting: To check for code quality, run:

    npm run lint
  • Formatting: To format your code, run:

    npm run format
  • Lint and Fix: To lint and automatically fix issues, run:

    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 file for details.

About

A command-line shell utility for setting up and managing Capture The Flag (CTF)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published