cb

README

= cb

image:https://badgers.space/badge/License/AGPL%20v3[License: GNU AGPLv3]
image:https://nogithub.codeberg.page/badge.svg[Please no Github.,link="https://nogithub.codeberg.page/"]

'''

A CLI for Codeberg.

An alternative to https://codeberg.org/VoiDD/fjo[fjo] and https://codeberg.org/RobWalt/codeberg-cli[berg].

Use the above if you like Rust.

== About

I made this for fun. 

Also because I like CLIs and the only available ones were made in Rust.

== Features

* Viewing info about a user
* Viewing your email addresses
* Viewing info about a repository
* Searching repositories
* Fetching from API endpoints
* List your notifications
* Adding email addresses
* Deleting email addresses
* Creating repositories

== Installation

Using Go:

[source,bash]
----
go install codeberg.org/Kaamkiya/cb
----

Otherwise:

. Get the latest stable build for your operating system from the https://codeberg.org/Kaamkiya/cb/releases[releases page]
. Rename it to `cb` so that you don't have to type the whole thing every time
. Move it somewhere in your `$PATH` (ideally `/usr/local/bin/`)
. Run this command on it: `chmod a+x /path/to/cb`
. Enter the `cb` command
. Et voilà!

== Roadmap

[cols="1,1,1"]
|===
|Scope                  |Request Type |Description

|repo                   |GET          |Print repository README when showing repository info.
|repo                   |DELETE       |Delete a repository
|repo                   |GET          |View a repo's wiki (`cb repo wiki <username>/<repo>`)
|pr                     |GET          |View PRs
|pr                     |GET          |List PRs for a repo
|pr                     |GET          |Search PRs
|user/notifications     |GET          |Read notifications
|user/notifications     |PATCH        |Mark as read or unread
|===

== License

This project uses the link:LICENSE[GNU Affero General Public License 3.0] (GNU APGLv3).