Back to Codeberg

README should be more descriptive #222

forgejo-contrib-forgejo-cli-issues-222.md

latest9.8 KB
Original Source

forgejo-contrib/forgejo-cli

Watch20

Star402

Fork

You've already forked forgejo-cli

51

CodeIssues 44Pull requests 8Releases 11Packages 2WikiActivity

README should be more descriptive #222

New issue

Closed

opened 2025-10-06 19:59:10 +02:00 by Cyborus · 1 comment

Cyborus commented 2025-10-06 19:59:10 +02:00

Member

Copy link

@mfenniak said in matrix:

forgejo-cli's README doesn't describe anything about what it actually does. Seems like a tool I might want to use, but I end up leaving the page because it doesn't describe anything about what it's for.

and he's right! "CLI tool for interacting with forgejo" is way too short.

The current "Installation" and "Usage" could be moved to the wiki. I'd like the README to be an introduction of what fj can do, and to point you to the wiki, which tells you how to do things.

@mfenniak said in matrix: > forgejo-cli's README doesn't describe anything about what it actually does. Seems like a tool I might want to use, but I end up leaving the page because it doesn't describe anything about what it's for. and he's right! "CLI tool for interacting with forgejo" is way too short. The current "Installation" and "Usage" could be moved to the wiki. I'd like the README to be an introduction of *what* fj can do, and to point you to the wiki, which tells you *how* to do things.

👍 1

Cyborus added the Kind/Documentation label 2025-10-06 19:59:10 +02:00

Cyborus referenced this issue from forgejo/discussions 2025-10-09 18:47:52 +02:00 Moving Cyborus/forgejo-cli towards being official? #400

Cyborus commented 2025-10-11 00:33:27 +02:00

Author

Member

Copy link

Something to include, since it came up in #223: a note that fj is not intended to be a drop-in replacement for gh (just as Forgejo is not meant to be a drop-in replacement for GitHub)

Something to include, since it came up in #223: a note that fj is not intended to be a drop-in replacement for gh (just as Forgejo is not meant to be a drop-in replacement for GitHub)

untitaker referenced this issue 2025-10-11 15:34:38 +02:00 feat: --autofill flag on pr create #223

Cyborus referenced this issue from forgejo/discussions 2025-10-16 21:21:39 +02:00 Moving Cyborus/forgejo-cli towards being official? #400

Cyborus added this to the v0.4.0 milestone 2025-12-01 17:00:35 +01:00

Cyborus removed this from the v0.4.0 milestone 2026-01-14 01:17:25 +01:00

Cyborus added this to the v0.4.0 milestone 2026-01-14 01:23:04 +01:00

Cyborus referenced this issue from a pull request that will close it, 2026-01-14 23:30:37 +01:00 docs: redesign README #273

Cyborus closed this issue 2026-01-15 14:53:00 +01:00

Sign in to join this conversation.

No Branch/Tag specified

BranchesTags

main

renovate/lock-file-maintenance

renovate/serde-saphyr-0.x

docs/contributing

no-port-in-refspec

login/v16.next.forgejo.org

crates-io-publish

0.5.x

compile-time-fluent

0.4.x

localization-alias-demo

api_url_field

v0.5.0

v0.4.1

v0.4.0

v0.3.0

v0.2.0

v0.1.1

v0.1.0

v0.0.4

v0.0.3

v0.0.2

v0.0.1

Labels

Clear labels[ Kind/Breaking Breaking change that won't be backward compatible

](#)[ Kind/Bug Something is not working

](#)[ Kind/Design Discussion about UI/UX design

](#)[ Kind/Documentation Documentation changes

](#)[ Kind/Enhancement Improve existing functionality

](#)[ Kind/Feature New functionality

](#)[ Kind/Security This is security issue

](#)[ Kind/Testing Issue or pull request related to testing

](#)[ Kind/Upstream This is an issue with upstream software (Forgejo) that is probably not our fault

](#)

[ Priority

Critical The priority is critical

](#)[ Priority

High The priority is high

](#)[ Priority

Low The priority is low

](#)[ Priority

Medium The priority is medium

](#)

[ Reviewed

Confirmed Issue has been confirmed

](#)[ Reviewed

Duplicate This issue or pull request already exists

](#)[ Reviewed

Invalid Invalid issue

](#)[ Reviewed

Won't Fix This issue won't be fixed

](#)

[ Status

Abandoned Somebody has started to work on this but abandoned work

](#)[ Status

Blocked Something is blocking this issue or pull request

](#)[ Status

Need More Info Feedback is required to reproduce issue or to continue work

](#)

[ Suspicious

](#)

No labels Kind/Breaking Kind/Bug Kind/Design Kind/Documentation Kind/Enhancement Kind/Feature Kind/Security Kind/Testing Kind/Upstream [ Priority

Critical ](/forgejo-contrib/forgejo-cli/issues?labels=173012) [ Priority

High ](/forgejo-contrib/forgejo-cli/issues?labels=173013) [ Priority

Low ](/forgejo-contrib/forgejo-cli/issues?labels=173015) [ Priority

Medium ](/forgejo-contrib/forgejo-cli/issues?labels=173014) [ Reviewed

Confirmed ](/forgejo-contrib/forgejo-cli/issues?labels=173007) [ Reviewed

Duplicate ](/forgejo-contrib/forgejo-cli/issues?labels=173005) [ Reviewed

Invalid ](/forgejo-contrib/forgejo-cli/issues?labels=173006) [ Reviewed

Won't Fix ](/forgejo-contrib/forgejo-cli/issues?labels=173008) [ Status

Abandoned ](/forgejo-contrib/forgejo-cli/issues?labels=173011) [ Status

Blocked ](/forgejo-contrib/forgejo-cli/issues?labels=173010) [ Status

Need More Info ](/forgejo-contrib/forgejo-cli/issues?labels=173009) Suspicious

Milestone

Clear milestone

No items

No milestone v0.4.0

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

forgejo-contrib/forgejo-cli#222

WritePreview

Loading…

Add table

| Rows | | | Columns | |

CancelOK

Add a link

Url Description Hint: With a URL in your clipboard, you can paste directly into the editor to create a link.

CancelOK

CancelSave

Reference in a new issue

Repository

forgejo-contrib/forgejo-cli

Title

Body

Create issue

No description provided.

Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?

No Yes