https://github.com/arch-err/m-ctf
A tool to manage CTFs on-the-go, to quickly structure your work and document your solutions
https://github.com/arch-err/m-ctf
bash ctf ctf-tools
Last synced: about 2 months ago
JSON representation
A tool to manage CTFs on-the-go, to quickly structure your work and document your solutions
- Host: GitHub
- URL: https://github.com/arch-err/m-ctf
- Owner: arch-err
- Created: 2024-10-22T14:47:41.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-07T20:43:32.000Z (4 months ago)
- Last Synced: 2025-02-07T21:28:41.079Z (4 months ago)
- Topics: bash, ctf, ctf-tools
- Language: Shell
- Homepage:
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Manage-CTFs
A tool to manage CTFs on-the-go, to structure your work and document your solutions quickly while playing a CTF.
# Installation
## One-line-install
*There will be a one-line-install available in the future, but for now you'll have to install the scripts dependencies manually.*
## Manually
### GitHub-CLI
This script uses githubs cli-tool `gh` to create repositories automatically. You will need to do the following in order to use this script:
1. Make sure you have the binary `gh` installed on your system
2. Generate a Personal Access Token on GitHub (**NOTE:** make sure that the token is authorized to create repositories)
3. Log in using your PAT with the `gh auth login` command
4. Fork my [ctf-template repo](https://github.com/arch-err/ctf-template) and make sure the repo is accessible under the address `https://github.com//ctf-template`
If you don't know how to do this you should check out the links below:
- https://cli.github.com/
- https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#further-reading
- https://cli.github.com/manual/gh_auth_login
- https://github.com/arch-err/ctf-template
- https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
### Dependencies
#### Arch-based systems (AUR)
```bash
yay -S gomplate-bin yq fzf git github-cli
or
paru -S gomplate-bin yq fzf git github-cli
```
#### Nix-systems (nix-env)
```bash
nix-env -iA gomplate yq fzf git gh
```
#### Debian-based systems (apt)
```bash
apt install yq fzf git gh
```
**NOTICE:** gomplate is not a very well-known tool and may therefore be a bit more difficult to install. Consult gomplates [install guide](https://docs.gomplate.ca/installing/) for more details.
### Download the script
You can clone this repo or download the script however you want (example commands below) and add the script to your path in any way you want.
#### Examples
```bash
$ git clone https://github.com/arch-err/m-ctf.git
or
$ curl -LO https://raw.githubusercontent.com/arch-err/m-ctf/refs/heads/main/code/mctf.sh?token=GHSAT0AAAAAACXAJZVOFKHAOHGVKRJDHHDSZYYBF7Q
```
#### Oneliner
```bash
$ curl -L https://raw.githubusercontent.com/arch-err/m-ctf/refs/heads/main/code/mctf.sh?token=GHSAT0AAAAAACXAJZVOFKHAOHGVKRJDHHDSZYYBF7Q -o /opt/mctf
```
# Usage
## 1. Initialization
```bash
$ mctf init
```
This command will initialize a git repo with metadata, READMEs, challenge-templates, and more.
This action is fully interactive and needs no more flags/switches or other types of given data before execution.
## 2. Solve challenges
```bash
$ mctf solve (optional)
or
$ mctf unsolve (optional)
```
This command gives you a menu to select a challenge, mark it as finished in the README, and then increment the counter that keeps track of solved challenges. Use `unsolve` to do the opposite.
## 3. Status
To show the status of the current CTF you can run the following command:
```bash
$ mctf status
```
*The image at the top of this README is an example of what the output of a `status` command can look like*
## 4. Add Challenges
To add new challenges to an already initialized CTF you can use the following command:
```bash
$ mctf add -b/--bulk (optional)
```
## 5. Sync with git
To sync your progress with git you can of course use git commands in any way you want, however, if just want so quickly push everything to git you can use the following command:
```bash
$ mctf sync
```