docs: add pullbasectl users delete command

[JohnAkindipe]

docs: add pullbasectl users delete command

Summary

Updates the CLI documentation to reflect the pullbasectl users delete subcommand implemented in the companion code PR here pullbase/pullbase#2

Previously, the reference docs stated that user deletion required the web UI or REST API and that CLI support was "planned". That note has been replaced with full documentation for the new command.

Changes

reference/cli.mdx

• Removed the <Info> note stating CLI user deletion was planned.
• Added a ### pullbasectl users delete section documenting the --user-id and
  --delete-acct-username flags and a usage example.

guides/pullbasectl.mdx

• Renamed the "Create/List Users" workflow section to "Create/List/Delete Users".
• Added a users delete example command to the section.

Related

• Companion code PR: feat: implement user deletion via pullbasectl CLI pullbase#2

Summary by CodeRabbit

• Documentation
  • Updated user management guides to include new user account deletion workflow with CLI command example.
  • Added CLI reference documentation for the delete users command with usage details and parameters.

[coderabbitai]

Warning

Review limit reached

@JohnAkindipe, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 25 minutes and 3 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0a45d9b9-f813-4759-aa42-2a773a24fd24

📥 Commits

Reviewing files that changed from the base of the PR and between 3720ddd and 5fc51a8.

📒 Files selected for processing (2)

• guides/pullbasectl.mdx
• reference/cli.mdx

📝 Walkthrough

Walkthrough

This PR documents a new CLI feature that enables user account deletion via pullbasectl users delete. The user guide is updated to reflect delete functionality alongside existing create/list operations, and complete CLI reference documentation is added with parameters and invocation examples.

Changes

User deletion CLI documentation

Layer / File(s)	Summary
User guide delete workflow guides/pullbasectl.mdx	The user workflow section heading is updated to "Create/List/Delete Users," and a new practical example is added showing the pullbasectl users delete command with server URL, user ID, and confirmation username flags.
CLI reference documentation reference/cli.mdx	Formal reference documentation for pullbasectl users delete is introduced, documenting the command description, required parameters (--user-id and --delete-acct-username), and a complete example. The earlier note stating user deletion was handled via web UI or REST API is replaced.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

A user's account, now swift to remove,
With pullbasectl and a username to prove,
The guides and the reference, in harmony aligned,
Document the feature, so clearly defined! 🐰✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately and concisely describes the main change: adding documentation for the pullbasectl users delete command.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (2)

reference/cli.mdx (1)

732-749: ⚡ Quick win

Consider documenting deletion restrictions and confirmation behavior.

The command documentation is complete and well-structured. To improve user experience, consider adding a note about important deletion restrictions and the confirmation mechanism, similar to the note on servers delete (lines 211-213).

📝 Suggested addition

 ### `pullbasectl users delete`
 
 Delete a user account.
 
 <ParamField flag="--user-id" type="integer" required>
 ID of the user to delete.
 </ParamField>
 <ParamField flag="--delete-acct-username" type="string" required>
 Username of the account to delete (used as confirmation).
 </ParamField>
+
+<Note>
+Deletion is blocked if you attempt to delete the last active admin or your own account. The `--delete-acct-username` flag serves as confirmation and must match the username associated with the user ID.
+</Note>
 
 ```bash
 pullbasectl users delete \

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@reference/cli.mdx` around lines 732 - 749, Update the pullbasectl users
delete docs to explicitly describe deletion restrictions and the confirmation
behavior: in the `pullbasectl users delete` section mention any constraints
(e.g., immutable/system/admin accounts, cascade effects, required permissions)
and explain that the --delete-acct-username flag is used as a confirmation step
(must match the user's username exactly) similar to the note in the `servers
delete` section; reference the command name and flags (--user-id,
--delete-acct-username) so readers know where to apply the note.

guides/pullbasectl.mdx (1)

165-170: ⚡ Quick win

Consider adding a note about deletion restrictions.

The delete example is clear and complete. However, based on the web UI documentation, user deletion has important restrictions (cannot delete the last active admin or your own account). Consider adding a brief tip or note to help users understand these limitations.

📝 Suggested addition

 # Delete a user's account
 docker compose exec central-server pullbasectl users delete \
   --server-url http://localhost:8080 \
   --user-id 7 \
   --delete-acct-username "SomeAccount123"
+
+<Tip>
+User deletion is blocked if you attempt to delete the last active admin or your own account.
+</Tip>

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@guides/pullbasectl.mdx` around lines 165 - 170, Add a brief note below the
"pullbasectl users delete" example explaining deletion restrictions: that you
cannot delete the last active admin and you cannot delete your own account;
update the guides/pullbasectl.mdx example block that contains the "pullbasectl
users delete" command to include a short tip or admonition (one or two
sentences) describing these limitations so readers see the constraints when
following the example.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@guides/pullbasectl.mdx`:
- Around line 165-170: Add a brief note below the "pullbasectl users delete"
example explaining deletion restrictions: that you cannot delete the last active
admin and you cannot delete your own account; update the guides/pullbasectl.mdx
example block that contains the "pullbasectl users delete" command to include a
short tip or admonition (one or two sentences) describing these limitations so
readers see the constraints when following the example.

In `@reference/cli.mdx`:
- Around line 732-749: Update the pullbasectl users delete docs to explicitly
describe deletion restrictions and the confirmation behavior: in the
`pullbasectl users delete` section mention any constraints (e.g.,
immutable/system/admin accounts, cascade effects, required permissions) and
explain that the --delete-acct-username flag is used as a confirmation step
(must match the user's username exactly) similar to the note in the `servers
delete` section; reference the command name and flags (--user-id,
--delete-acct-username) so readers know where to apply the note.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 23586fd7-d4a3-484c-84af-77f37ce21564

📥 Commits

Reviewing files that changed from the base of the PR and between edc690b and 3720ddd.

📒 Files selected for processing (2)

• guides/pullbasectl.mdx
• reference/cli.mdx