{"id":20974743,"url":"https://github.com/tintoy/ps-reptile","last_synced_at":"2025-05-14T13:31:59.410Z","repository":{"id":92909064,"uuid":"82498096","full_name":"tintoy/ps-reptile","owner":"tintoy","description":"A MAML-format help generator for binary PowerShell modules.","archived":false,"fork":false,"pushed_at":"2017-12-27T17:35:27.000Z","size":56,"stargazers_count":2,"open_issues_count":3,"forks_count":5,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-18T03:28:39.337Z","etag":null,"topics":["maml","powershell","powershell-help"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tintoy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-02-19T23:46:53.000Z","updated_at":"2023-03-26T20:45:56.000Z","dependencies_parsed_at":"2023-03-13T17:24:34.642Z","dependency_job_id":null,"html_url":"https://github.com/tintoy/ps-reptile","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tintoy%2Fps-reptile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tintoy%2Fps-reptile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tintoy%2Fps-reptile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tintoy%2Fps-reptile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tintoy","download_url":"https://codeload.github.com/tintoy/ps-reptile/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254150545,"owners_count":22022976,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["maml","powershell","powershell-help"],"created_at":"2024-11-19T04:32:49.707Z","updated_at":"2025-05-14T13:31:58.780Z","avatar_url":"https://github.com/tintoy.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PS-Reptile (a MAML generator for binary PowerShell modules)\n\nUnlike script modules, authoring help content for binary modules often involves manually authoring a `.xml` help file in [MAML](https://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language) (Microsoft Assistance Markup Language) format.\nIf, like me, you think this [sounds incredibly tedious](https://msdn.microsoft.com/en-us/library/bb525433.aspx#code-snippet-1), then perhaps this tool will be useful. It examines the primary assembly for a binary module (and, optionally, its XML documentation comments) and generates the corresponding MAML help content.\n\n## Custom attribute example 1 (inline help)\n\n```csharp\n[Cmdlet(VerbsCommon.Get, \"Foo\")]\n[OutputType(typeof(FooConnectionProfile))]\n[CmdletHelp(\"Retrieve information about one or more Foo connection profiles.\")]\npublic class GetFooConnection\n{\n    [Parameter(HelpMessage = \"Retrieve all connection profiles\")]\n    public SwitchParameter All { get; set; }\n}\n```\n\n## Custom attribute example 1 (inline help)\n\n```csharp\n[Cmdlet(VerbsCommon.Get, \"Foo\")]\n[OutputType(typeof(FooConnectionProfile))]\n[CmdletHelp(\n    Synopsis = \"Retrieve information about one or more Foo connection profiles\",\n    Description = @\"\n        This Cmdlet retrieves information about Foo connection profiles.\n        The connection profiles are persisted in $HOME/.foo/connection-profiles.json.\n    \"\n)]\npublic class GetFooConnection\n{\n    [Parameter]\n    [ParameterHelpFromFile(\"Help/Connections/Get-FooConnection/All.txt\")]\n    public SwitchParameter All { get; set; }\n}\n```\n\n## XML documentation comments example\n\n```csharp\n/// \u003csummary\u003eRetrieve information about one or more Foo connection profiles.\u003c/summary\u003e\n[Cmdlet(VerbsCommon.Get, \"Foo\")]\n[OutputType(typeof(FooConnectionProfile))]\npublic class GetFooConnection\n{\n    /// \u003csummary\u003eRetrieve all connection profiles.\u003c/summary\u003e\n    [Parameter]\n    public SwitchParameter All { get; set; }\n}\n```\n\n## Mix-and-match example\n\n```csharp\n/// \u003csummary\u003eRetrieve information about one or more Foo connection profiles.\u003c/summary\u003e\n[Cmdlet(VerbsCommon.Get, \"Foo\")]\n[OutputType(typeof(FooConnectionProfile))]\npublic class GetFooConnection\n{\n    [Parameter(HelpMessage = \"Retrieve all connection profiles\")]\n    public SwitchParameter All { get; set; }\n}\n```\n\n# Usage\n\nInstall package `PSReptile` into your project; it contains only attribute definitions that you can apply to your Cmdlets. The generator is part of the `PSReptile.Generator` package, or just add `PSReptile.Build` as a design-time package to automatically generate help when you build your project.\n\n# Notes\n\nThis project is very much a work-in-progress:\n\n* If you have questions or comments, feel free to raise an issue.\n* If you'd like to pitch in, any and all assistence will be greatly appreciated :-)\n\nEventually, we'll also implement a `dotnet` command-line plugin to invoke this tool.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftintoy%2Fps-reptile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftintoy%2Fps-reptile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftintoy%2Fps-reptile/lists"}