Zeek Package Manager
  • 1. Quickstart Guide
    • 1.1. Dependencies
    • 1.2. Installation
    • 1.3. Basic Configuration
    • 1.4. Advanced Configuration
    • 1.5. Usage
      • 1.5.1. Package Upgrades/Versioning
      • 1.5.2. Offline Usage
  • 2. zkg Command-Line Tool
    • 2.1. Commands
      • 2.1.1. test
      • 2.1.2. install
      • 2.1.3. remove
      • 2.1.4. purge
      • 2.1.5. bundle
      • 2.1.6. unbundle
      • 2.1.7. refresh
      • 2.1.8. upgrade
      • 2.1.9. load
      • 2.1.10. unload
      • 2.1.11. pin
      • 2.1.12. unpin
      • 2.1.13. list
      • 2.1.14. search
      • 2.1.15. info
      • 2.1.16. config
      • 2.1.17. autoconfig
      • 2.1.18. env
      • 2.1.19. create
      • 2.1.20. template info
    • 2.2. Config File
  • 3. How-To: Create a Package
    • 3.1. Bootstrapping packages with zkg
      • 3.1.1. Concepts
      • 3.1.2. The create command
      • 3.1.3. Obtaining information about a template
    • 3.2. Walkthroughs
      • 3.2.1. Pure Zeek Script Package
      • 3.2.2. Binary Zeek Plugin Package
      • 3.2.3. ZeekControl Plugin Package
      • 3.2.4. Registering to a Package Source
    • 3.3. Package Metadata
      • 3.3.1. description field
      • 3.3.2. aliases field
      • 3.3.3. credits field
      • 3.3.4. tags field
        • 3.3.4.1. Suggested Tags
      • 3.3.5. script_dir field
      • 3.3.6. plugin_dir field
      • 3.3.7. executables field
      • 3.3.8. build_command field
        • 3.3.8.1. Value Interpolation
      • 3.3.9. user_vars field
      • 3.3.10. test_command field
      • 3.3.11. config_files field
      • 3.3.12. depends field
      • 3.3.13. external_depends field
      • 3.3.14. suggests field
    • 3.4. Package Versioning
      • 3.4.1. Creating New Package Release Versions
      • 3.4.2. Package Upgrade Process
  • 4. How-To: Create a Package Source
    • 4.1. Package Source Setup
    • 4.2. Package Index Files
    • 4.3. Adding Packages
    • 4.4. Removing Packages
    • 4.5. Aggregating Metadata
  • 5. Python API Reference
    • 5.1. zeekpkg.manager module
      • Manager
        • Manager.sources
        • Manager.installed_pkgs
        • Manager.zeek_dist
        • Manager.state_dir
        • Manager.user_vars
        • Manager.backup_dir
        • Manager.log_dir
        • Manager.scratch_dir
        • Manager.script_dir
        • Manager.plugin_dir
        • Manager.bin_dir
        • Manager.source_clonedir
        • Manager.package_clonedir
        • Manager.package_testdir
        • Manager.manifest
        • Manager.autoload_script
        • Manager.autoload_package
        • Manager.SourceAggregationResults
        • Manager.add_source()
        • Manager.aggregate_source()
        • Manager.backup_modified_files()
        • Manager.bundle()
        • Manager.bundle_info()
        • Manager.discover_builtin_packages()
        • Manager.find_builtin_package()
        • Manager.find_installed_package()
        • Manager.get_installed_package_dependencies()
        • Manager.has_plugin()
        • Manager.has_scripts()
        • Manager.info()
        • Manager.install()
        • Manager.installed_package_dependencies()
        • Manager.installed_packages()
        • Manager.list_depender_pkgs()
        • Manager.load()
        • Manager.load_with_dependencies()
        • Manager.loaded_package_states()
        • Manager.loaded_packages()
        • Manager.match_source_packages()
        • Manager.modified_config_files()
        • Manager.package_build_log()
        • Manager.package_versions()
        • Manager.pin()
        • Manager.refresh_installed_packages()
        • Manager.refresh_source()
        • Manager.remove()
        • Manager.restore_loaded_package_states()
        • Manager.save_temporary_config_files()
        • Manager.source_packages()
        • Manager.test()
        • Manager.unbundle()
        • Manager.unload()
        • Manager.unload_with_unused_dependers()
        • Manager.unpin()
        • Manager.upgrade()
        • Manager.validate_dependencies()
        • Manager.zeek_plugin_path()
        • Manager.zeekpath()
      • Stage
        • Stage.get_subprocess_env()
        • Stage.populate()
    • 5.2. zeekpkg.package module
      • InstalledPackage
        • InstalledPackage.package
        • InstalledPackage.status
        • InstalledPackage.fullfills()
        • InstalledPackage.is_builtin()
      • METADATA_FILENAME
      • Package
        • Package.git_url
        • Package.name
        • Package.source
        • Package.directory
        • Package.metadata
        • Package.aliases()
        • Package.dependencies()
        • Package.is_builtin()
        • Package.matches_path()
        • Package.name_with_source_directory()
        • Package.qualified_name()
        • Package.short_description()
        • Package.tags()
        • Package.user_vars()
      • PackageInfo
        • PackageInfo.package
        • PackageInfo.status
        • PackageInfo.metadata
        • PackageInfo.versions
        • PackageInfo.metadata_version
        • PackageInfo.version_type
        • PackageInfo.invalid_reason
        • PackageInfo.metadata_file
        • PackageInfo.aliases()
        • PackageInfo.best_version()
        • PackageInfo.dependencies()
        • PackageInfo.is_builtin()
        • PackageInfo.short_description()
        • PackageInfo.tags()
        • PackageInfo.user_vars()
      • PackageStatus
        • PackageStatus.is_loaded
        • PackageStatus.is_pinned
        • PackageStatus.is_outdated
        • PackageStatus.tracking_method
        • PackageStatus.current_version
        • PackageStatus.current_hash
      • PackageVersion
        • PackageVersion.fullfills()
      • aliases()
      • canonical_url()
      • dependencies()
      • is_valid_name()
      • make_builtin_package()
      • name_from_path()
      • short_description()
      • tags()
      • user_vars()
    • 5.3. zeekpkg.source module
      • AGGREGATE_DATA_FILE
      • INDEX_FILENAME
      • Source
        • Source.name
        • Source.git_url
        • Source.clone
        • Source.package_index_files()
        • Source.packages()
    • 5.4. zeekpkg.template module
      • Error
      • Feature
        • Feature.name()
      • GitError
      • InputError
      • LoadError
      • OutputError
      • Package
        • Package.do_instantiate()
      • Template
        • Template.api_version()
        • Template.apply_user_vars()
        • Template.define_param()
        • Template.define_user_vars()
        • Template.features()
        • Template.has_repo()
        • Template.info()
        • Template.is_api_compatible()
        • Template.load()
        • Template.lookup_param()
        • Template.name()
        • Template.package()
        • Template.params()
        • Template.templatedir()
        • Template.version()
        • Template.version_branch()
        • Template.version_sha()
    • 5.5. zeekpkg.uservar module
      • UserVar
        • UserVar.default()
        • UserVar.desc()
        • UserVar.name()
        • UserVar.parse_arg()
        • UserVar.parse_dict()
        • UserVar.resolve()
        • UserVar.set()
        • UserVar.val()
      • slugify()
  • 6. Developer's Guide
    • 6.1. Versioning/Releases
    • 6.2. Documentation
      • 6.2.1. Dependencies
      • 6.2.2. Local Build/Preview
      • 6.2.3. Remote Hosting
      • 6.2.4. Style Conventions
    • 6.3. Internals
      • 6.3.1. zkg's view of a package
      • 6.3.2. Directory usage
        • 6.3.2.1. $STATEDIR/clones
        • 6.3.2.2. $STATEDIR/scratch
        • 6.3.2.3. $STATEDIR/testing
Zeek Package Manager
  • Search

© Copyright 2019, The Zeek Project.

Built with Sphinx using a theme provided by Read the Docs.