agentleFS
Sign inStart free
apacheapache/iotdb/scripts/AGENTS.md

iotdb / scripts

AGENTS.md6.4k starsChanged 4 years agoApache-2.0View on GitHub

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License…

We split this AGENTS.md into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run bash -n on each edited Bash script.

    line 62
  2. Distinctive:

    Keep new cases similarly isolated.

    line 71

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md
<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -->

Script Guidelines

These instructions apply to scripts/ and supplement the repository instructions.

Shared sources and platform behavior

  • conf/ holds environment setup and shared helpers, sbin/ holds launchers, and tools/ holds operational utilities. Their Windows counterparts live in the respective windows/ directories. Review the counterpart when changing shared behavior and keep arguments, configuration handling, and exit status consistent where applicable.
  • Scripts are copied into several distributions. Read distribution/AGENTS.md before changing packaged file names, locations, or dependencies. Update original sources here rather than copies under target/.
  • Resolve installation paths relative to the script or the supported environment override, not the caller's working directory. Preserve IOTDB_HOME, IOTDB_CONF, data/log directory, and JAVA_HOME handling. Quote paths and forwarded arguments, including paths with spaces.
  • Reuse conf/iotdb-common.sh and conf/windows/iotdb-common.bat for shared behavior. Preserve Maven-filtered placeholders such as @tsfile.locale.opt@; inspect the packaged result when changing them. Keep supported Linux/macOS branches and explicitly guard platform-specific operations such as systemd integration.

Edge lifecycle and cleanup

  • Edge startup must use the configuration-aware ConfigNode and DataNode port checks in the shared helpers. Preserve custom configuration paths and fail before launching when required validation fails; do not substitute hardcoded default-port checks.
  • Edge stop logic must match both the org.apache.iotdb.edge.EdgeNode main class and the exact installation IOTDB_HOME, including when recovering from a missing/stale PID file. Validate ownership again before forced termination; never fall back to a global process-name kill.
  • Preserve Edge daemon tracking of the forked JVM through edge.pid. During cleanup, stop only the matching installation's systemd service before stopping the process so it cannot restart while its data is being removed. Propagate stop/service failures instead of continuing.
  • Preserve cleanup confirmation and force-option behavior. Read effective configured data paths, including legacy configuration and multiple data tiers, and validate every target before deleting any. Retain protection for filesystem/home roots, parent directories, and symlink aliases. Report deletion failures instead of printing a success message.

Verification

  • Run bash -n on each edited Bash script. This checks syntax only; exercise changed argument, path, process, and failure behavior with an isolated installation or the existing harness.

  • For Edge operational scripts or their assembly selection, run from the repository root:

    python3 .github/scripts/test-edge-ops.py

    The harness covers cleanup, daemon behavior, and assembly selection with temporary fixtures. Keep new cases similarly isolated; do not use an existing installation or real system service as a cleanup fixture.

  • For Windows Edge launchers, also run on Windows from the repository root:

    powershell -NoProfile -File .github/scripts/test-edge-windows.ps1

    These checks are wired into Edge IT. Report platform-specific checks that could not run; Unix results do not establish Windows behavior.

  • For packaged launcher or environment changes, rebuild the affected distribution and smoke-test its extracted scripts. Verify custom configuration, an unrelated working directory, occupied ports, and isolation from another installation when those behaviors are affected. Follow distribution verification for archive checks and Edge IT instructions for Tree/Table read-write verification.

Download now (ZIP)

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 1 mentionMar 2026: 1 mentionApr 2026: 2 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 1 mentionAug 2026: 0 mentionsSep 2026: 1 mentionOct 2026: 1 mentionNov 2026: 0 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the apache/iotdb repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about apache/iotdb

The biggest 5 of 28 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 28

Talked about on GitHub, Bluesky and Hacker News (28 times).

On GitHub · 23

18 more on GitHub

On Bluesky · 4

On Hacker News · 1

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free