nextcloud / nextcloud/documentation

Document `occ app:..` --flags and usage examples

Open
#11,549 2 comments 1 reaction 1 assignee View on GitHub

@Antreesy is already working on this.

Since Feb 16, 2024.

1. to develop feature: occ manual: admin
Dominant language
JavaScript
Stars
628
Forks
2.5k
Avg merge
2d 11h
Merged PRs (30d)
135

Description

Documentation doesn't cover functionality of occ commands (such as enabling an app for specific groups), which could confuse admin user while attempting to set up the instance. Flag --help is providing documented flag, but without usage examples

root@bfd4c603dbb2:/var/www/html# occ app:enable --help
Description:
  enable an app

Usage:
  app:enable [options] [--] <app-id>...

Arguments:
  app-id                enable the specified app

Options:
  -g, --groups=GROUPS   enable the app only for a list of groups (multiple values allowed)
  -f, --force           enable the app regardless of the Nextcloud version requirement
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --no-warnings     Skip global warnings, show command output only
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.