{"id":18554299,"url":"https://github.com/oracle/tax-reporting-framework-cli","last_synced_at":"2025-04-09T23:31:09.133Z","repository":{"id":37802949,"uuid":"418315197","full_name":"oracle/tax-reporting-framework-cli","owner":"oracle","description":"Tax Reporting Framework CLI is a tool for generating boilerplate codes to quickly setup and deploy your reports using Tax Reporting Framework SuiteApp in NetSuite.","archived":false,"fork":false,"pushed_at":"2023-08-29T13:13:15.000Z","size":305,"stargazers_count":5,"open_issues_count":0,"forks_count":8,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-24T13:21:27.592Z","etag":null,"topics":["cli","netsuite","reports","tax","tax-reporting-framework","trf"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"upl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-18T02:23:25.000Z","updated_at":"2024-08-29T19:25:27.000Z","dependencies_parsed_at":"2024-11-06T21:22:49.060Z","dependency_job_id":"9d0fb95d-db97-4362-aebc-ee4f1936df47","html_url":"https://github.com/oracle/tax-reporting-framework-cli","commit_stats":{"total_commits":94,"total_committers":11,"mean_commits":8.545454545454545,"dds":0.5425531914893618,"last_synced_commit":"a2426a4e9c8dfb962eefeb49bd316d851f92e7a4"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ftax-reporting-framework-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ftax-reporting-framework-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ftax-reporting-framework-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Ftax-reporting-framework-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle","download_url":"https://codeload.github.com/oracle/tax-reporting-framework-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248129612,"owners_count":21052606,"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":["cli","netsuite","reports","tax","tax-reporting-framework","trf"],"created_at":"2024-11-06T21:21:09.017Z","updated_at":"2025-04-09T23:31:06.632Z","avatar_url":"https://github.com/oracle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tax Reporting Framework CLI\r\nTax Reporting Framework CLI is a tool for generating boilerplate codes to quickly setup and deploy your reports using Tax Reporting Framework SuiteApp in NetSuite.\r\n\r\n## What is Tax Reporting Framework?\r\nTax Reporting Framework is a powerful reporting framework that uses JSON schema for report definition, freemarker templates for report output and supports Saved Searches and SuiteQL as data source. It was previously named *SuiteTax Reports* but with the recent support for Legacy environment it was renamed to **Tax Reporting Framework**. \r\n\r\n## Installation\r\n### Installation using NPM\r\n```\r\nnpm install -g @oracle/tax-reporting-framework-cli\r\n```\r\n### No installation required using NPX\r\n```\r\nnpx @oracle/tax-reporting-framework-cli create\r\n```\r\n\r\n## Usage\r\n```\r\nUsage: trf [options] [command]\r\n\r\n🚀 TRF CLI 🚀\r\n\r\nOptions:\r\n  -V, --version  output the version number\r\n  -h, --help     output usage information\r\n\r\nCommands:\r\n  create         create new TRF project 😎\r\n```\r\n\r\n## Sample\r\n```\r\ntrf create\r\n? Select project type.  TAF\r\n? Select search type.  suiteql\r\n? Enter project name. (The project ID must not be empty and can contain only lowercase alphabetic and numeric characters)\r\n localization-ireland\r\n? Enter report country.  IE\r\n------------------\r\n🚀 TRF CLI 🚀\r\n------------------\r\nProject Name:  localization-ireland\r\nProject Type:  TAF\r\nCountry:  IE\r\n✨ Done in 0.005s!\r\n```\r\n## Account Customization Project Additional steps to replace SDF Installer\r\nSince **run** tag in **deploy.xml** is not supported in SuiteCloud Account Customization Project\r\n\r\nManually run the installation scripts to install the localization Bundle, Report, SavedSearch in TRF\r\n\r\n#### Account Customization Project Manual Bundle Record Installation\r\nGo to **Customization** \u003e **Scripting** \u003e **Scripts**  \r\n\r\n1. Go to filters type select **Scheduled** \r\n2. View **STR Bundle Installer SS**\r\n3. Go to **Deployments** tab\r\n4. Select 1 deployment and edit\r\n5. Go to **Parameters tab**\r\n6. Populate the parameters as follows: GUID: Project GUID, Filename: str_localized_bundle.json\r\n7. Trigger **Save and Execute**\r\n\r\n#### Account Customization Project Manual Report Installation\r\nGo to **Customization** \u003e **Scripting** \u003e **Scripts**  \r\n\r\n1. Go to filters type select **Map/Reduce** \r\n2. View **ReportSchema Installer MR**\r\n3. Go to **Deployments** tab\r\n4. Select 1 deployment and edit\r\n5. Go to **Parameters tab**\r\n6. Populate the parameters as follows: UUID: Project GUID, Filename: str_localized_report_list.json\r\n7. Trigger **Save and Execute**\r\n\r\n#### Account Customization Project Manual SavedSearch Installation\r\nGo to **Customization** \u003e **Scripting** \u003e **Scripts**  \r\n\r\n1. Go to filters type select **Map/Reduce** \r\n2. View **STR Search Installer MR**\r\n3. Go to **Deployments** tab\r\n4. Select 1 deployment and edit\r\n5. Go to **Parameters tab**\r\n6. Populate the parameters as follows: UUID: Project GUID, Filename: str_localized_searches.json\r\n7. Trigger **Save and Execute**\r\n\r\n## Contributing\r\nThis project is not accepting external contributions at this time. For bugs or enhancement requests, please file a GitHub issue unless it’s security related. When filing a bug remember that the better written the bug is, the more likely it is to be fixed. If you think you’ve found a security vulnerability, do not raise a GitHub issue and follow the instructions in our [security policy](./SECURITY.md).\r\n\r\n## Security\r\n\r\nPlease consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process\r\n\r\n## License\r\nCopyright (c) 2021 Oracle and/or its affiliates The Universal Permissive License (UPL), Version 1.0.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Ftax-reporting-framework-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle%2Ftax-reporting-framework-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Ftax-reporting-framework-cli/lists"}