{"id":15090077,"url":"https://github.com/drbh/jikan","last_synced_at":"2026-02-02T05:47:59.892Z","repository":{"id":254743305,"uuid":"844280759","full_name":"drbh/jikan","owner":"drbh","description":"kinda like github action but for everything else","archived":false,"fork":false,"pushed_at":"2024-09-08T03:41:43.000Z","size":200,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-10T09:46:27.203Z","etag":null,"topics":["actions","agents","automation","workflows"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/drbh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2024-08-18T23:09:43.000Z","updated_at":"2024-09-08T03:41:45.000Z","dependencies_parsed_at":"2024-08-27T03:21:43.503Z","dependency_job_id":null,"html_url":"https://github.com/drbh/jikan","commit_stats":null,"previous_names":["drbh/jikan"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drbh%2Fjikan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drbh%2Fjikan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drbh%2Fjikan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/drbh%2Fjikan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/drbh","download_url":"https://codeload.github.com/drbh/jikan/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244825183,"owners_count":20516587,"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":["actions","agents","automation","workflows"],"created_at":"2024-09-25T09:20:27.425Z","updated_at":"2026-02-02T05:47:59.858Z","avatar_url":"https://github.com/drbh.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jikan (時間): Simplified Workflow Execution\n\n\u003e [!CAUTION]\n\u003e This project is in the early stages of development and is not yet stable. Please use with caution and expect breaking changes as 1.0.0 approaches.\n\nJikan is a lightweight workflow execution daemon inspired by GitHub Actions, offering more features than cron while being simpler than traditional workflow engines and CI/CD pipelines.\n\n## Table of Contents\n\n1. [Quick Start](#quick-start)\n2. [Core Concepts](#core-concepts)\n3. [Installation](#installation)\n4. [Basic Usage](#basic-usage)\n5. [Workflow Configuration](#workflow-configuration)\n6. [Command Reference](#command-reference)\n7. [Advanced Usage](#advanced-usage)\n8. [Troubleshooting](#troubleshooting)\n9. [Contributing](#contributing)\n10. [License](#license)\n\n## Quick Start\n\n1. Clone the repository:\n\n```bash\n# install `jikand` and `jk` binaries (into ~/.local/bin)\ncurl -fsSL https://raw.githubusercontent.com/drbh/jikan/main/install.sh | sh\n```\n\n2. Start the Jikan daemon:\n\n```bash\njikand\n# or run in the background\njikand daemon\n# and to stop the daemon\njikand stop\n```\n\n3. Create a simple workflow file (e.g., `.jikan/workflows/hello-world.yaml`):\n\n```yaml\nname: hello-world\non:\n  schedule:\n    - cron: \"0 0 * * * * *\" # Run every minute\njobs:\n  say-hello:\n    runs-on: bash\n    steps:\n      - run: echo \"Hello, Jikan!\"\n```\n\n\u003e [!TIP]\n\u003e It's recommend to create a directory/repo (similar to github actions) to store your workflows. For example, the directory structure should be similar to the `example/daily-brief` directory:\n\n```bash\n.\n├── .jikan\n│   └── workflows\n│       └── daily-brief.yaml\n└── daily_brief.md\n```\n\n4. Add all the workflows in the directory:\n\n```bash\ncd example/daily-brief\njk init\n# Server response: Registered 1 workflows in namespace 'daily-brief'.\n```\n\n5. List your workflows:\n\n```bash\njk list daily-brief\n# Server response: Workflows:\n# - daily-brief (namespace: daily-brief)\n```\n\n6. See the next scheduled run:\n\n```bash\njk next daily-brief daily-brief\n# Server response: Workflow 'daily-brief' in namespace 'daily-brief' will run in 1239 seconds.\n# Absolute time: Sun, 25 Aug 2024 14:07:00 -0400\n```\n\n7. Run the workflow manually:\n\n```bash\njk run daily-brief daily-brief\n# Server response: Workflow 'daily-brief' in namespace 'daily-brief' ran successfully.\n```\n\nafter running the workflow, you should see the output in the `daily_brief.md` file:\n\n```bash\ncat ./daily_brief.md\n# Good morning! Here's your daily brief:\n# Sunday, August 25, 2024\n# ## Today's Weather\n# jfk\n\n#      \\  /       Partly cloudy\n#    _ /\"\".-.     +23(25) °C\n#      \\_(   ).   ↑ 19 km/h\n#      /(___(__)  16 km\n#                 0.0 mm\n```\n\n🙌 awesome, you just registered and ran your first Jikan workflow!\n\n## Core Concepts\n\n- **Workflows**: Defined tasks that Jikan executes based on triggers.\n- **Namespaces**: Logical groupings for organizing workflows.\n- **Jobs**: Individual units of work within a workflow.\n- **Triggers**: Events that initiate workflow execution (e.g., schedules, manual runs).\n\n## Basic Usage\n\n1. Start the Jikan daemon:\n\n```bash\njk --help\n```\n\n2. Use the `jk` tool to interact with Jikan:\n\n```bash\njk command [arguments]\n```\n\n## Workflow Configuration\n\nCreate YAML files to define your workflows. Example:\n\n```yaml\nname: my-workflow\nrun-name: some-run-name\non:\n  schedule:\n    - cron: \"0 0 0 * * * *\" # Run daily at midnight\n\njobs:\n  example-job:\n    runs-on: bash\n    steps:\n      - run: echo \"This is a test\"\n  python-job:\n    runs-on:\n      python-external: .venv/bin/python\n    steps:\n      - run: func.py\n```\n\nLearn more about syntax and how it compares to Github Actions in [SYNTAX.md](SYNTAX.md).\n\n## Command Reference\n\n### Workflow Management\n\n- List workflows:\n\n```bash\njk list [namespace]\n```\n\n- Get workflow details:\n\n```bash\njk get [namespace] [name]\n```\n\n- Run a workflow:\n\n```bash\njk run [namespace] [name]\n```\n\n- List namespaces:\n\n```bash\njk list_namespaces\n```\n\n### Environment Variables\n\n- Set an environment variable:\n\n```bash\njk set_env [namespace] [name] [key] [value]\n```\n\n- Get an environment variable:\n\n```bash\njk get_env [namespace] [name] [key]\n```\n\n- List environment variables:\n\n```bash\njk list_env [namespace] [name]\n```\n\n- Checking the next scheduled run:\n\n```bash\njk next [namespace] [name]\n```\n\n- View last Run:\n\n```bash\njk last [namespace] [name]\n```\n\n## Troubleshooting\n\n- If Jikan fails to start, check the log file at `~/.jikan/jikan.log`.\n- Ensure all required dependencies are installed and up-to-date.\n- Verify that your workflow YAML files are correctly formatted.\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get started.\n\n## License\n\nJikan is released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrbh%2Fjikan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdrbh%2Fjikan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdrbh%2Fjikan/lists"}