Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
catalandres committed Jan 10, 2024
1 parent f18bb75 commit 3e473ca
Showing 1 changed file with 46 additions and 15 deletions.
61 changes: 46 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,7 @@

[![NPM](https://img.shields.io/npm/v/plugin-atlas.svg?label=plugin-atlas)](https://www.npmjs.com/package/plugin-atlas) [![Downloads/week](https://img.shields.io/npm/dw/plugin-atlas.svg)](https://npmjs.org/package/plugin-atlas) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-documentation/main/LICENSE.txt)

# Table of contents

<!-- toc -->

# Usage

<!-- usage -->
<!-- tocstop -->

## Vision

Expand Down Expand Up @@ -106,28 +100,65 @@ Currently supported metadata types:

<!-- commands -->

- [`sf doc generate atlas`](#sf-doc-generate-atlas)
- [`sf atlas generate csv`](#sf-atlas-generate-csv)
- [`sf atlas generate xlsx`](#sf-atlas-generate-xlsx)

## `sf atlas generate csv`

Generate CSV files from the contents of your local project, with a separate file for each supported metadata type.

```
USAGE
$ sf atlas generate csv [--json] [-d <value>]
FLAGS
-d, --output-dir=<value> [default: PROJECT_FOLDER/atlas/csv/YYYYMMDD-HHMMSS/] Folder where the CSV files will be
saved.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Generate CSV files from the contents of your local project, with a separate file for each supported metadata type.
You must run this command from within a project.
EXAMPLES
$ sf atlas generate csv
FLAG DESCRIPTIONS
-d, --output-dir=<value> Folder where the CSV files will be saved.
More information about a flag. Don't repeat the summary.
```

## `sf doc generate atlas`
## `sf atlas generate xlsx`

Generate documentation from the contents of your local project.
Generate an XLSX spreadsheet from the contents of your local project, with a sheet for each supported metadata type.

```
USAGE
$ sf doc generate atlas [--json]
$ sf atlas generate xlsx [--json] [-f <value>]
FLAGS
-f, --output-file=<value> [default: PROJECT_FOLDER/atlas/xlsx/atlas-YYYYMMDD-HHMMSS.xlsx] Name and path of the XLSX
file to be generated.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Generate documentation from the contents of your local project.
Generate an XLSX spreadsheet from the contents of your local project, with a sheet for each supported metadata type.
You must run this command from within a project.
Note that the default behavior is to create an XLSX spreadsheet with a sheet for each supported metadata type. This
will change in an upcoming release.
EXAMPLES
$ sf doc generate atlas
$ sf atlas generate xlsx
FLAG DESCRIPTIONS
-f, --output-file=<value> Name and path of the XLSX file to be generated.
More information about a flag. Don't repeat the summary.
```

<!-- commandsstop -->

0 comments on commit 3e473ca

Please sign in to comment.