CoE CLI-Entwicklungsdokumentation (veraltet)

Note

Die CoE CLI ist veraltet, und es werden keine neuen Features hinzugefügt. Probleme werden nicht mehr überprüft oder behoben.

Wenn Sie ein potenzielles Sicherheitsproblem identifizieren, melden Sie es bitte an die Microsoft Security Response Center.

Zusätzlich zum Power Platform Admin Center, erwägen Sie die Microsoft Power Platform CLI, Power Platform API, Power Platform Inventory API und die Power Platform for Admins V2 connector.

Die Dokumentation ist der Schlüssel zum Verständnis der Funktionsweise der CLI. Beachten Sie beim Hinzufügen neuer Befehle die folgende Dokumentation:

Hinzufügen von Markdownseiten

Fügen Sie neue Seiten zu Hilfeseiten hinzu, die den neuen Befehl beschreiben und dem Benutzer die erwartete Nutzung erklären.

Erwägen Sie, der Seite Folgendes hinzuzufügen:

  1. Statische Bilder, die den Vorgang zusammenfassen.
  2. Notieren Sie die Befehlszeile , um den Prozess zu veranschaulichen.

Diagramme

Bei Entscheidungsstrukturen werden die Diagramme über Mermaid generiert.

Beispieldiagramme:

Diagrammstile

So formatieren Sie das Diagrammbeispiel.mmd:

  1. Verwenden Sie Untergruppenstile.

    graph
    subgraph journey[Journey]
      start(Start) --> finish(Finish Here)
    end

    style journey fill:transparent,stroke:green,stroke-width:2px

  2. Wenden Sie CSS-Stile mit einer Datei im selben Ordner an. Erstellen Sie z. B. sample.css im selben Ordner wie die MMD-Datei.

    #L-start-finish path {
   stroke: red
}

Notes

  1. Überprüfen Sie die Knotenformen, um die angezeigten Symbole zu steuern.

  2. Gestalten Sie Kreise mithilfe der folgenden Methode.

    graph TD
   subgraph Journey
      start(Start Here) ---> finish((End Here))
   end

    Um den Endkreis grün zu färben, verwenden Sie das CSS-Attribut ^=Wertmarkierer. Diese Auswahl ist erforderlich, da jedem Element eine eindeutige ID von Mermaid zugeordnet wird.

    [id^=flowchart-finish] circle {
   stroke: green;
   fill: lightgreen
}

  3. Färbe eine Linie. Jede Linie hat das Format „L-start-finish“ für path, das ist die Linie, und die Klasse .path, das ist die Linie um die Pfeilspitze.

    #L-start-finsh path,
#L-start-finsh .path
 {
   stroke: green;
}

Diagramme aktualisieren

Die statischen Bilder für jedes Diagramm werden wie folgt generiert.

  1. Wechseln Sie in den Ordner coe-cli.

    cd coe-cli

  2. Generieren Sie statische Dateien.

    npm run diagrams

Hilfeseiten hinzufügen

Fügen Sie neue Hilfeseiten zur Hilfe hinzu. Jede Seite in der Hilfe enthält detaillierte Informationen zum Befehl und zu den Optionen. Auf die Hilfe-Markdown-Datei kann mithilfe des Hilfebefehls zugegriffen werden, der die zugehörige Hilfe-Markdown-Datei im Konsolenfenster anzeigt.

coe help alm

Mit diesem Befehl wird der Inhalt der Hilfe angezeigt.

Befehlszeile aufzeichnen

Um eine kurze animierte Aufzeichnung von Befehlen einzuschließen, die die erwartete Ausgabe veranschaulichen, verwenden Sie den folgenden Prozess.

  1. Installieren Sie termtosvg in einem Unix-basierten Terminal.

    pip3 install --user termtosvg

    Dieser Prozess funktioniert plattformübergreifend, und jede der folgenden Optionen kann verwendet werden:

  2. Zeichnen Sie die Sitzung in einer CAST-Datei auf.

    termtosvg record test.cast

    Die generierte CAST-Datei ist eine einfache Textdatei, die mit jedem Texteditor bearbeitet werden kann.

  3. Entfernen Sie Pausen mit term-trim.ps1.

    ./term-trim.ps1 -Input test.cast -Output test2.cast -Trim 1

  4. Generieren Sie die SVG-Datei.

    termtosvg render test2.cast test.svg -t window_frame
  • Last updated on