imdone-cli 0.1.0

package/LICENSE.md

@@ -0,0 +1,47 @@
+# Imdone with Jira - License Agreement
+
+Copyright (c) 2025 Innobuilt Software LLC. All rights reserved.
+
+This software and associated documentation files (the “Software”) is licensed, not sold. By installing, copying, or using Imdone with Jira, you agree to be bound by the terms of this License Agreement.
+
+## 1. Grant of License
+
+You are granted a non-exclusive, non-transferable license to use the Software solely for personal or internal business use, subject to the following conditions:
+
+- A valid license key is required to activate and use the Software.
+- The Software may be installed on one or more machines, depending on the terms of your license.
+- You may not sublicense, rent, lease, or otherwise distribute the Software.
+
+## 2. Restrictions
+
+You may not:
+
+- Reverse engineer, decompile, disassemble, or attempt to derive the source code of the Software.
+- Modify or create derivative works of the Software.
+- Share, publish, or otherwise disclose your license key.
+- Use the Software in violation of any applicable laws or regulations.
+
+## 3. License Validation
+
+The Software may perform periodic online or offline validation of your license key to ensure compliance with this license. If validation fails, the Software may be disabled.
+
+## 4. Ownership
+
+All rights, title, and interest in and to the Software are owned by Jesse Piascik. This license does not grant you any rights to the source code or any intellectual property owned by the licensor, except as explicitly stated.
+
+## 5. Termination
+
+This license is effective until terminated. Failure to comply with any of its terms will result in automatic termination. Upon termination, you must destroy all copies of the Software.
+
+## 6. No Warranty
+
+The Software is provided “as is” without warranty of any kind. In no event shall the author be liable for any damages arising from the use of the Software.
+
+## 7. Support and Updates
+
+Support and updates are not guaranteed. Any updates provided will be governed by this license unless accompanied by a separate license.
+
+---
+
+For licensing questions or enterprise options, contact: support@imdone.io
+For more information, visit: [imdone.io](https://imdone.io)

package/README.md

@@ -0,0 +1,136 @@
+# Imdone CLI
+
+Imdone CLI is a command-line tool that enables seamless integration between Imdone and Jira. It allows you to pull issues from Jira to your Imdone board and push changes back to Jira, making project management easier and more efficient.
+
+## Installation
+
+```bash
+npm install -g imdone-cli
+```
+
+Or if you prefer to use it locally in a project:
+
+```bash
+npm install --save-dev imdone-cli
+```
+
+## Prerequisites
+
+- Node.js v14 or higher
+- A valid Imdone license
+- Jira account with API access
+
+## Commands
+
+### Initialize Jira Integration
+
+Set up your project for Jira integration:
+
+```bash
+imdone init
+```
+
+Options:
+- `--name`: Project name
+- `--jira-url`: Jira URL (e.g., https://your-domain.atlassian.net)
+- `--jira-project-key`: Jira project key (e.g., ABC)
+- `--jira-username`: Jira username (email)
+- `--jira-api-token`: Jira API token
+- `--jql`: JQL query to fetch issues (e.g., "Sprint in openSprints() and status != 'Done'")
+
+Example:
+```bash
+imdone init --name "My Project" --jira-url "https://mycompany.atlassian.net" --jira-project-key "PROJ"
+```
+
+### Pull Issues from Jira
+
+Pull issues from Jira to your local Imdone board:
+
+```bash
+imdone pull
+```
+
+This command fetches issues from Jira based on your JQL query and adds them to your Imdone board.
+
+### Push Changes to Jira
+
+Push updates you've made in Imdone back to Jira:
+
+```bash
+imdone push
+```
+
+This command synchronizes changes you've made to issues in Imdone (like status changes or updates to descriptions) back to your Jira project.
+
+### License Management
+
+Enter or update your Imdone license:
+
+```bash
+imdone license --token YOUR_LICENSE_TOKEN
+```
+
+Options:
+- `--token`: License token
+- `--show`: Display current license information
+
+Examples:
+```bash
+# Enter a license token
+imdone license
+
+# Provide a license token directly
+imdone license --token eyJhbGciOiJSUzI...
+
+# View current license information
+imdone license --show
+```
+
+## Project Structure
+
+When initializing a project, Imdone CLI will:
+
+1. Check if you're in a git repository
+2. Create or update the .env file for storing credentials
+3. Add necessary entries to .gitignore
+4. Set up the Imdone project configuration
+
+## Environment Variables
+
+The following environment variables are used by Imdone CLI:
+
+- `JIRA_USERNAME`: Your Jira username/email
+- `JIRA_TOKEN`: Your Jira API token
+- `IMDONE_LICENSE`: Your Imdone license token
+
+These are typically stored in a `.env` file in your project root.
+
+## Troubleshooting
+
+### Invalid License
+
+If you see the error "Invalid or expired license", please check that:
+
+1. Your license token is valid
+2. Your license hasn't expired
+3. The license is properly set in your environment variables
+
+You can view your license details with:
+```bash
+imdone license --show
+```
+
+### Connection Issues
+
+If you're having trouble connecting to Jira, verify:
+
+1. Your Jira URL is correct
+2. Your Jira credentials are valid
+3. You have the necessary permissions in Jira
+
+## Support
+
+If you encounter any issues or need assistance, please contact support@imdone.io
+
+