{"id":36577633,"url":"https://github.com/paradocs-cli/paradocs","last_synced_at":"2026-01-12T07:37:56.691Z","repository":{"id":61005633,"uuid":"454095126","full_name":"paradocs-cli/paradocs","owner":"paradocs-cli","description":"paradocs is a tool for automating documentation for code including IaC, k8s, and modern programming languages. ","archived":false,"fork":false,"pushed_at":"2023-01-02T21:12:07.000Z","size":4488,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-11-15T03:52:40.274Z","etag":null,"topics":["documentation","golang","terraform"],"latest_commit_sha":null,"homepage":"","language":"Go","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/paradocs-cli.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}},"created_at":"2022-01-31T17:04:43.000Z","updated_at":"2023-01-05T00:49:29.000Z","dependencies_parsed_at":"2023-02-01T04:17:28.184Z","dependency_job_id":null,"html_url":"https://github.com/paradocs-cli/paradocs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/paradocs-cli/paradocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paradocs-cli%2Fparadocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paradocs-cli%2Fparadocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paradocs-cli%2Fparadocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paradocs-cli%2Fparadocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paradocs-cli","download_url":"https://codeload.github.com/paradocs-cli/paradocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paradocs-cli%2Fparadocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28336606,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["documentation","golang","terraform"],"created_at":"2026-01-12T07:37:56.143Z","updated_at":"2026-01-12T07:37:56.684Z","avatar_url":"https://github.com/paradocs-cli.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ParaDocs \n\n## What the tool is for: \n* Generating documentation for cloud native tools\n* Generating documentation for cloud resources deployed via Terraform, Pulumi, ARM, etc.\n* Generating documentation for k8s(Helm etc.)\n* Future use cases\n  * Docs generated for modern programming languages\n  * Docs generated for Projects via Azure DevOps, Jira, and GitHub \n  * Integration for agnostic pipeline support \n## How to install: \n  * Run ```make all``` in your shell \n    * This will compile the exe and add it to your $PATH \n    * If the ```make``` command fails, install Make by using Chocolatey and running ```choco make install```\n  * Test with ```paradocs --help```\n## How to use ParaDocs:\n### Authentication for state providers: \n#### Google Cloud \n[Oauth2Token Creation](https://developers.google.com/identity/protocols/oauth2) (Needed for authentication to Cloud Storage API)\u003cbr\u003e\n[REST API Docs](https://cloud.google.com/storage/docs/downloading-objects) (You will need to authorize your token as seen below)\u003cbr\u003e\n![img.png](assets/gcpapi.png)\n#### AWS\n[Access Developer Credentials](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/getting-your-credentials.html)\n![Developer Creds](assets/awscredssnip.png)\n* You will need the following \n  * Session Token \n  * Access Key\n  * Secret Access Key\n  * Region \n  * S3 Bucket Name \n  * Object Name/Path\n#### Azure\n[Create a SAS token for storage blob](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=Containers) \u003cbr\u003e\n![Access Blob](assets/gensas.png)\u003cbr\u003e\nOnly grab the actual token field for cli use\u003cbr\u003e\n![Only Token](assets/sastoken.png)\n\n#### Terraform Cloud (TFC ONLY NO ENTERPRISE CURRENTLY!) \n[Create API Token](https://www.terraform.io/cloud-docs/users-teams-organizations/api-tokens)\n* You will need the following:\n  * API token \n  * Workspace ID\n### Terraform documentation:\n### Sample commands:\n* ```paradocs code terraform --working-dir \u003cinsert target path here\u003e```\n  * All docs that are generated will be stored in current working directory\n  * Future support being added to specificy what directory to ouput too as well as running against remote code stored in GitHub, Gitlab, etc\n## How to contribute:\n  * Request access \n  * Fork repo \n  * Add features \n  * Submit PR \n### Working with Cobra:\n  [Cobra CLI Docs](https://github.com/spf13/cobra) \u003cbr\u003e\n  [Viper Docs](https://github.com/spf13/viper)\n### Pull requests:\n#### All PR's have the following policies for approval: \n1. Minimum required reviewers \n2. Code review by code owners \n3. All checks must pass(builds)\n4. Code merged to main via PR only\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparadocs-cli%2Fparadocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparadocs-cli%2Fparadocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparadocs-cli%2Fparadocs/lists"}